Get Product Group

Get a product group with its connected products (in manual-sort order) and companies.

Read this detail before editing the product group so that existing fields and relationships can be preserved.

Behaviour

Products and companies are managed via their own endpoints.

Requires the productGroups:read scope.

get

Authorizations

AuthorizationstringRequired

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

Path parameters

productGroupIdstringRequired

Product group identifier (PG-).

Example: PG-123e4567-e89b-12d3-a456-426614174000Pattern: ^PG-[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}$

Responses

200

Successful response.

application/json

400

Invalid request data.

application/json

401

Missing or invalid API key.

application/json

403

The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).

application/json

404

Resource not found.

application/json

429

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.

application/json

500

Internal server error.

application/json

get/v1/product-groups/{productGroupId}

GET /v1/product-groups/{productGroupId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "productGroupId": "PG-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "SHARED",
    "status": "ACTIVE",
    "numberOfProducts": 1,
    "numberOfCompanies": 1,
    "manualSort": true,
    "companyIds": [
      "text"
    ],
    "connectedProducts": [
      {
        "productId": "text",
        "name": "text",
        "status": "text"
      }
    ]
  }
}