Get Global Option Set

Get a global option set with its options.

Read this detail before editing the global option set so that existing fields and relationships can be preserved.

Behaviour

Localized fields (display name, description, option names and comments) are translated to lang; omit lang to get the full { language: text } maps instead — the options upsert stores an option exactly as sent, so editing one language means sending the others back with it.

Requires the globalOptionSets:read scope.

get

Authorizations

AuthorizationstringRequired

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

Path parameters

optionSetIdstringRequired

Global option set identifier (OPT-).

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

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

Example: en

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/global-option-sets/{optionSetId}

GET /v1/global-option-sets/{optionSetId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "optionSetId": "OPT-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "displayName": "Chair",
    "description": "Chair",
    "status": "ACTIVE",
    "numberOfOptions": 1,
    "createdAt": "text",
    "modifiedAt": "text",
    "tags": [
      "text"
    ],
    "options": [
      {
        "id": "text",
        "code": "text",
        "name": "Chair",
        "comment": "Chair",
        "priceCode": "text",
        "fbPriceCode": "text",
        "additionalPriceCode": "text",
        "material3dId": "text",
        "arMaterial3dId": "text",
        "additionalPriceCodeQuantity": 1,
        "filters": {
          "<parameterId>": [
            "<valueId>"
          ]
        },
        "metafields": {
          "lead-time-weeks": 10,
          "care-label": "Wipe clean"
        },
        "src": "text"
      }
    ]
  }
}