For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

get
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Query parameters
limitinteger · min: 1 · max: 5000OptionalDefault: 50
cursorstring · min: 1Optional
langstring · min: 2 · max: 10Optional

Language code to translate localized fields to (falls back if unavailable).

Example: en
searchstring · min: 1 · max: 255Optional
statusstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
visibilitystring · enumOptionalPossible values:
isOwnstring · enumOptionalPossible values:
isSharedWithOthersstring · enumOptionalPossible values:
isBrokenstring · enumOptionalPossible values:
variantCodestring · min: 1 · max: 255Optional
createdFromstringOptional
createdTostringOptional
modifiedFromstringOptional
modifiedTostringOptional
Responses
200

Successful response.

application/json
get/v1/products
GET /v1/products HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": [
    {
      "productId": "PROD-123e4567-e89b-12d3-a456-426614174000",
      "variantCode": "text",
      "name": "text",
      "displayName": "text",
      "status": "ACTIVE",
      "visibility": true,
      "privacy": "PUBLIC",
      "type": "2D",
      "mode": "STANDARD",
      "variantType": "STANDARD",
      "previewImage": "text",
      "isOwn": true,
      "isSharedWithOthers": true,
      "isBroken": true,
      "owner": "text",
      "ownerCode": "text",
      "createdAt": "text",
      "modifiedAt": "text"
    }
  ],
  "page": {
    "limit": 1,
    "nextCursor": "text"
  }
}

Last updated

Was this helpful?