> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/developers/price-lists.md).

# Price Lists

Price lists.

## Get Price List

> Get a price list with its codes, validity, currency, calculation settings, and attached companies.\
> \
> Requires the \`priceLists:read\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Price Lists","description":"Price lists."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"PriceListsDetail":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^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}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"FIXED"},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["costMultiplier"],"additionalProperties":false},"body":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"object","properties":{"priceCode":{"type":"string"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"sale":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["priceCode","quantity","rrp","sale"],"additionalProperties":false}}},"required":["codes"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","market","calculation","body"],"additionalProperties":false},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^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}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"CALCULATED"},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectedCustomers":{"type":"array","items":{"type":"string"}},"selectedProducts":{"type":"array","items":{"type":"string"}},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^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}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"LINKED"},"linkedPriceListId":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","linkedPriceListId","calculation"],"additionalProperties":false}]}},"required":["data"],"additionalProperties":false},"PublicError":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string"},"details":{"description":"Optional error-specific details (e.g. per-field validation reasons)."}}}}},"paths":{"/v1/price-lists/{priceListId}":{"get":{"summary":"Get Price List","tags":["Price Lists"],"description":"Get a price list with its codes, validity, currency, calculation settings, and attached companies.\n\nRequires the `priceLists:read` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceListsDetail"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"parameters":[{"name":"priceListId","in":"path","required":true,"schema":{"type":"string","pattern":"^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}$"}}]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.mimeeq.com/developers/price-lists.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.