Get Price List

Read a price list’s mode, currency, validity, calculation settings, fixed-price codes and attached companies. Use List Price Lists to obtain the priceListId.

Read this detail before updating the list so you can preserve the full settings required by its mode. Company assignments are managed through Update Company Price Lists.

Requires the priceLists:read scope.

get

Authorizations

AuthorizationstringRequired

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

Path parameters

priceListIdstringRequiredPattern: ^PL-[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/price-lists/{priceListId}

GET /v1/price-lists/{priceListId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "priceListId": "PL-123e4567-e89b-12d3-a456-426614174000",
    "priceListName": "text",
    "status": "text",
    "currency": "text",
    "validPeriod": [],
    "isPromotional": true,
    "companies": [
      {
        "companyId": "text",
        "companyName": "text"
      }
    ],
    "createdAt": "text",
    "modifiedAt": "text",
    "mode": "text",
    "market": "text",
    "calculation": {
      "costMultiplier": 1
    },
    "body": {
      "codes": [
        {
          "priceCode": "text",
          "quantity": 1,
          "rrp": 1,
          "sale": 1
        }
      ]
    }
  }
}