> 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/companies.md).

# Companies

Customer companies and their price-list assignments.

## List Companies

> List companies. Optionally filter by \`status\` or by a case-insensitive \`search\` over the company name. Results are cursor-paginated.\
> \
> Requires the \`companies:read\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Companies","description":"Customer companies and their price-list assignments."}],"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":{"CompaniesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[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":"Company identifier (COMP-<uuid>)."},"companyNumericId":{"type":"number"},"companyName":{"type":"string"},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"accountManagerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["companyId","companyNumericId","companyName","address","email","workNumber","currency","status","accountManagerId","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"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/companies":{"get":{"summary":"List Companies","tags":["Companies"],"description":"List companies. Optionally filter by `status` or by a case-insensitive `search` over the company name. Results are cursor-paginated.\n\nRequires the `companies:read` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesList"}}}},"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"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":5000}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ACTIVE","INACTIVE"]}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1}}]}}}}
```

## Create Company

> Create a company. \`currency\` must be configured for your customer; otherwise the request returns 422. The main address is supplied as a nested \`address\` object.\
> \
> Requires the \`companies:write\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Companies","description":"Customer companies and their price-list assignments."}],"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":{"CompaniesMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[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":"Company identifier (COMP-<uuid>)."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string"},"currency":{"type":"string"}},"required":["companyId","status","companyName","currency"],"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)."}}},"CompaniesCreateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string","minLength":1,"maxLength":255},"currency":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false},"email":{"type":"string","minLength":1,"maxLength":255},"workNumber":{"type":"string","minLength":1,"maxLength":255},"accountManagerId":{"type":"string","pattern":"^USER-[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}$"},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"paymentTerms":{"type":"string","minLength":1,"maxLength":255},"deliveryAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[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}$"},"name":{"type":"string","minLength":1,"maxLength":255},"street":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255},"companyName":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false}},"socials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[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}$"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string","minLength":1,"maxLength":255}},"required":["type","address"],"additionalProperties":false}}},"required":["status","companyName","currency"],"additionalProperties":false}}},"paths":{"/v1/companies":{"post":{"summary":"Create Company","tags":["Companies"],"description":"Create a company. `currency` must be configured for your customer; otherwise the request returns 422. The main address is supplied as a nested `address` object.\n\nRequires the `companies:write` scope.","responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesMutation"}}}},"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"}}}},"422":{"description":"Unprocessable entity (e.g. an unconfigured currency or quotation stage).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesCreateRequest"}}}}}}}}
```

## Get Company

> Get a company with its delivery addresses, socials, contacts, and attached price-list summaries.\
> \
> Requires the \`companies:read\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Companies","description":"Customer companies and their price-list assignments."}],"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":{"CompaniesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[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":"Company identifier (COMP-<uuid>)."},"companyNumericId":{"type":"number"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManagerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManager":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"paymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveryAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","street","postcode","country","companyName","city"],"additionalProperties":false}},"socials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string"}},"required":["id","type","address"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contactId","firstName","lastName"],"additionalProperties":false}},"priceLists":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string"},"priceListName":{"type":"string"},"status":{"type":"string"}},"required":["priceListId","priceListName","status"],"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."}},"required":["companyId","companyNumericId","status","companyName","currency","address","email","workNumber","accountManagerId","accountManager","tags","paymentTerms","deliveryAddresses","socials","contacts","priceLists","createdAt","modifiedAt"],"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/companies/{companyId}":{"get":{"summary":"Get Company","tags":["Companies"],"description":"Get a company with its delivery addresses, socials, contacts, and attached price-list summaries.\n\nRequires the `companies:read` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesDetail"}}}},"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":"companyId","in":"path","required":true,"schema":{"type":"string","pattern":"^COMP-[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}$"}}]}}}}
```

## Update Company

> Replace a company with the supplied fields. Required fields and supplied arrays are authoritative: omit an optional array to clear it. \`currency\` must be configured for your customer.\
> \
> Requires the \`companies:write\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Companies","description":"Customer companies and their price-list assignments."}],"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":{"CompaniesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[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":"Company identifier (COMP-<uuid>)."},"companyNumericId":{"type":"number"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManagerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManager":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"paymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveryAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","street","postcode","country","companyName","city"],"additionalProperties":false}},"socials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string"}},"required":["id","type","address"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contactId","firstName","lastName"],"additionalProperties":false}},"priceLists":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string"},"priceListName":{"type":"string"},"status":{"type":"string"}},"required":["priceListId","priceListName","status"],"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."}},"required":["companyId","companyNumericId","status","companyName","currency","address","email","workNumber","accountManagerId","accountManager","tags","paymentTerms","deliveryAddresses","socials","contacts","priceLists","createdAt","modifiedAt"],"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)."}}},"CompaniesCreateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string","minLength":1,"maxLength":255},"currency":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false},"email":{"type":"string","minLength":1,"maxLength":255},"workNumber":{"type":"string","minLength":1,"maxLength":255},"accountManagerId":{"type":"string","pattern":"^USER-[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}$"},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"paymentTerms":{"type":"string","minLength":1,"maxLength":255},"deliveryAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[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}$"},"name":{"type":"string","minLength":1,"maxLength":255},"street":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255},"companyName":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false}},"socials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[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}$"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string","minLength":1,"maxLength":255}},"required":["type","address"],"additionalProperties":false}}},"required":["status","companyName","currency"],"additionalProperties":false}}},"paths":{"/v1/companies/{companyId}":{"put":{"summary":"Update Company","tags":["Companies"],"description":"Replace a company with the supplied fields. Required fields and supplied arrays are authoritative: omit an optional array to clear it. `currency` must be configured for your customer.\n\nRequires the `companies:write` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesDetail"}}}},"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"}}}},"422":{"description":"Unprocessable entity (e.g. an unconfigured currency or quotation stage).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","pattern":"^COMP-[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}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesCreateRequest"}}}}}}}}
```

## List Company Notes

> List a company's notes, including attachments with public file URLs.\
> \
> Requires the \`companies:read\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Companies","description":"Customer companies and their price-list assignments."}],"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":{"CompaniesNotes":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"noteId":{"type":"string"},"noteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"noteContent":{"description":"Rich note content. Shape is note-defined (opaque)."},"attachments":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public file URL, or null when unavailable."},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileId","filePath","label"],"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."}},"required":["noteId","noteTitle","noteContent","attachments","createdAt","modifiedAt"],"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/companies/{companyId}/notes":{"get":{"summary":"List Company Notes","tags":["Companies"],"description":"List a company's notes, including attachments with public file URLs.\n\nRequires the `companies:read` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesNotes"}}}},"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":"companyId","in":"path","required":true,"schema":{"type":"string","pattern":"^COMP-[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}$"}}]}}}}
```

## Update Company Price Lists

> Attach and/or detach price lists for a company. Provide at least one non-empty list; a price-list id cannot appear in both lists. Every id being attached must exist (\`404 price\_list\_not\_found\` otherwise, naming the unknown ids in \`details\`); ids being detached are not checked. Returns the refreshed price-list summaries.\
> \
> Requires the \`companies:write\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Companies","description":"Customer companies and their price-list assignments."}],"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":{"CompaniesMutation2":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[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":"Company identifier (COMP-<uuid>)."},"priceLists":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string"},"priceListName":{"type":"string"},"status":{"type":"string"}},"required":["priceListId","priceListName","status"],"additionalProperties":false}}},"required":["companyId","priceLists"],"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)."}}},"CompaniesPriceListsRequest":{"type":"object","properties":{"priceListIdsToAttach":{"minItems":1,"maxItems":50,"type":"array","items":{"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}$"}},"priceListIdsToDelete":{"minItems":1,"maxItems":50,"type":"array","items":{"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}$"}}},"additionalProperties":false}}},"paths":{"/v1/companies/{companyId}/price-lists":{"post":{"summary":"Update Company Price Lists","tags":["Companies"],"description":"Attach and/or detach price lists for a company. Provide at least one non-empty list; a price-list id cannot appear in both lists. Every id being attached must exist (`404 price_list_not_found` otherwise, naming the unknown ids in `details`); ids being detached are not checked. Returns the refreshed price-list summaries.\n\nRequires the `companies:write` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesMutation2"}}}},"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":"companyId","in":"path","required":true,"schema":{"type":"string","pattern":"^COMP-[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}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesPriceListsRequest"}}}}}}}}
```


---

# 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/companies.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.