> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/products/list-products.md).

# List Products

List products.

Use this as the discovery step for a catalogue integration. Pass a returned productId to Get Product for full configuration data.

### Behaviour

Filter by text, status, type, mode, privacy, ownership, visibility, lifecycle dates, or variant code; repeat `mode`, `privacy`, and `variantType` to match multiple values.

Only a product shared with you can be broken, so `isBroken=true` implies `isOwn=false` unless you send `isOwn` yourself; asking for `isBroken=true` with `isOwn=true` always answers with an empty page.

Results are cursor-paginated.

Requires the `products:read` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"tags":[{"name":"Products","description":"Read the configurable products available to your Mimeeq account. Use these endpoints to build a catalogue integration, retrieve a product's configuration, or find related products.\n\n> **These endpoints are read-only.** Create and edit products in the Mimeeq app; this API section does not provide product creation, update, or deletion operations.\n\n## What you can do\n\n| Task | Operation |\n| --- | --- |\n| Find products using filters and pagination | [List Products](https://help.mimeeq.com/developers/products/list-products) |\n| Read a product's full configuration | [Get Product](https://help.mimeeq.com/developers/products/get-product) |\n| Find products related to a selected product | [List Related Products](https://help.mimeeq.com/developers/products/list-related-products) |\n\n## Before you start\n\nYour API key needs the `products:read` scope. Start with List Products and use the returned `productId` in subsequent requests.\n\nList Products supports filters for text, status, product type, configurator mode, privacy, ownership, visibility, lifecycle dates, and variant code. See the operation for the supported values. Follow [Pagination](https://help.mimeeq.com/developers/pagination) when retrieving more than one page.\n\n## Product configuration and related resources\n\nGet Product returns the full configuration. Its structure can vary by product and configurator type, so check the response before selecting fields for your integration. Use the `lang` parameter when you need localized fields, including the description, in a particular language.\n\nUse [Product Categories](https://help.mimeeq.com/developers/product-categories) to work with the category hierarchy, and [Product Groups](https://help.mimeeq.com/developers/product-groups) for groups of products used for sharing or embedding."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production API"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"ProductsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"visibility":{"type":"boolean"},"privacy":{"anyOf":[{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["2D","3D"]},{"type":"null"}]},"mode":{"anyOf":[{"type":"string","enum":["STANDARD","VARIANT","MODULAR","COMPONENT"]},{"type":"null"}]},"variantType":{"anyOf":[{"type":"string","enum":["STANDARD","HYBRID"]},{"type":"null"}]},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOwn":{"type":"boolean"},"isSharedWithOthers":{"type":"boolean"},"isBroken":{"type":"boolean"},"owner":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownerCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["productId","variantCode","name","displayName","status","visibility","privacy","type","mode","variantType","previewImage","isOwn","isSharedWithOthers","isBroken","owner","ownerCode","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Products (GET /v1/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"PublicError":{"description":"An API error response. Use code and the HTTP status to classify the failure, message and optional details for context, and requestId when reporting it. Edge firewall responses may omit requestId.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string","description":"Present on every error the API itself returns; absent when the edge firewall rejected the request."},"details":{"description":"Optional error-specific details (e.g. per-field validation reasons)."}}}}},"paths":{"/v1/products":{"get":{"summary":"List Products","tags":["Products"],"description":"List products.\n\nUse this as the discovery step for a catalogue integration. Pass a returned productId to Get Product for full configuration data.\n\n## Behaviour\n\nFilter by text, status, type, mode, privacy, ownership, visibility, lifecycle dates, or variant code; repeat `mode`, `privacy`, and `variantType` to match multiple values.\n\nOnly a product shared with you can be broken, so `isBroken=true` implies `isOwn=false` unless you send `isOwn` yourself; asking for `isBroken=true` with `isOwn=true` always answers with an empty page.\n\nResults are cursor-paginated.\n\nRequires the `products:read` scope.","responses":{"200":{"description":"Successful response.","headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductsList"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"429":{"description":"The API key exceeded its request rate (`rate_limit_exceeded`) or its monthly quota (`quota_exceeded`). Both carry `Retry-After`; the `RateLimit-*` headers accompany `rate_limit_exceeded` only, since a spent quota says nothing about the bucket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}}},"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":5000}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":10,"description":"Language code to translate localized fields to (falls back if unavailable)."}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":255}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ACTIVE","INACTIVE"]}},{"name":"mode","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["STANDARD","VARIANT","MODULAR","COMPONENT"]}}},{"name":"privacy","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]}}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["2D","3D"]}},{"name":"variantType","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["STANDARD","HYBRID"]}}},{"name":"visibility","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"isOwn","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"isSharedWithOthers","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"isBroken","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"variantCode","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":255}},{"name":"createdFrom","in":"query","required":false,"schema":{"type":"string"}},{"name":"createdTo","in":"query","required":false,"schema":{"type":"string"}},{"name":"modifiedFrom","in":"query","required":false,"schema":{"type":"string"}},{"name":"modifiedTo","in":"query","required":false,"schema":{"type":"string"}}]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/products/list-products.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.