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

Get Product

Read the full configuration of a configurable product available to your Mimeeq account. Use a productId returned by List Products.

The response structure depends on the product and configurator type; inspect its actual fields before mapping it into another system. Supply lang for localized fields where supported. This endpoint does not edit the product.

Requires the products:read scope.

get
Authorizations
AuthorizationstringRequired

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

Path parameters
productIdstringRequiredPattern: ^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}$
Query parameters
langstring · min: 2 · max: 10Optional

When set, localized fields including description use this language.

Example: en
Responses
200

Successful response.

application/json
get/v1/products/{productId}
GET /v1/products/{productId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": {
    "productId": "PROD-123e4567-e89b-12d3-a456-426614174000",
    "sourceId": "text",
    "variantCode": "text",
    "name": "Chair",
    "displayName": "Chair",
    "description": {
      "html": "text",
      "text": "text"
    },
    "brand": "text",
    "manufacturer": "text",
    "designer": "text",
    "status": "ACTIVE",
    "visibility": true,
    "privacy": "PUBLIC",
    "type": "2D",
    "mode": "STANDARD",
    "variantType": "STANDARD",
    "previewImage": "text",
    "categoryIds": [],
    "companyGroupIds": [],
    "productGroupIds": [],
    "tags": [],
    "isOwn": true,
    "isSharedWithOthers": true,
    "isBroken": true,
    "owner": "text",
    "ownerCode": "text",
    "sharingSettings": null,
    "modularSettings": null,
    "optionSets": [],
    "groups": [],
    "groupContainers": [],
    "groupsPreview": null,
    "businessLogic": [],
    "pricing": null,
    "bom": [],
    "bundleSettings": null,
    "sceneSettings": null,
    "models3dUrl": "text",
    "meshesUrl": "text",
    "animationGroupsUrl": "text",
    "components3d": [],
    "products": [],
    "connectedProducts": [],
    "priceListsInScope": [],
    "sharingTab": [],
    "tabs": [],
    "createdAt": "text",
    "modifiedAt": "text"
  }
}

Last updated

Was this helpful?