> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/evo-stock-api/suppliers.md). # Suppliers Supplier directory ## List suppliers > Returns all suppliers for the authenticated organisation, ordered by supplier name ascending. ```json {"openapi":"3.0.1","info":{"title":"EvoStock APIM Operations API","version":"0.1"},"tags":[{"name":"Suppliers","description":"Supplier directory"}],"servers":[{"url":"https://apim-hospitality-prod-uksouth.azure-api.net/evo/stock/v1","description":"Production"},{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/evo/stock/v1","description":"Development"},{"url":"https://apim-hospitality-stg-uksouth.azure-api.net/evo/stock/v1","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 client credentials JWT obtained from the Access Identity M2M token endpoint (`POST https://api.hos.accessacloud.com/platform/m2m-auth/v1/token`). The token request must use `grant_type=client_credentials` with `audience=fandb-platform-api evo-stock` and `scope=fandb.read fandb.write openid`. The response returns `{ \"access_token\": \"\", \"expires_in\": 3599, \"scope\": \"fandb.read fandb.write openid\", \"token_type\": \"bearer\" }`. Tokens expire after `expires_in` seconds (typically ~1 hour). APIM validates the token at the gateway and resolves the calling organisation from the token claims — no additional headers are required."}},"parameters":{"PageSize":{"name":"page_size","in":"query","required":false,"description":"Number of items per page. Clamped to the range [1, 500]. Defaults to 100.","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},"Cursor":{"name":"cursor","in":"query","required":false,"description":"Opaque cursor for keyset pagination. Pass the next_cursor value from a previous response to fetch the next page.","schema":{"type":"string"}}},"schemas":{"PaginatedResponse":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"Pagination":{"type":"object","required":["page_size","has_next_page","next_cursor"],"properties":{"page_size":{"type":"integer","description":"The page size used for this request."},"has_next_page":{"type":"boolean","description":"Whether more results exist beyond this page."},"next_cursor":{"type":"string","nullable":true,"description":"Cursor to pass as the cursor query parameter for the next page. Null when there are no more results."}}},"Supplier":{"type":"object","required":["id","tenantId","supplierCode","supplierName","active","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique supplier identifier (CUID)."},"tenantId":{"type":"string"},"supplierCode":{"type":"string","maxLength":50},"supplierName":{"type":"string","maxLength":255},"contactName":{"type":"string","nullable":true,"maxLength":255},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":50},"address":{"type":"string","nullable":true},"paymentTerms":{"type":"string","nullable":true,"maxLength":100},"logoS3Key":{"type":"string","nullable":true},"active":{"type":"boolean"},"externalSupplierId":{"type":"integer","nullable":true},"sourceSystem":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message."}}}},"responses":{"Unauthorized":{"description":"Missing, invalid, or expired authorization token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"OrganizationNotFound":{"description":"No tenant found matching the token's subject claim.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/apim/suppliers":{"get":{"operationId":"GetSuppliers","summary":"List suppliers","description":"Returns all suppliers for the authenticated organisation, ordered by supplier name ascending.","tags":["Suppliers"],"parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Paginated list of suppliers.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/OrganizationNotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` --- # 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: ``` GET https://docs.hos.accessacloud.com/evo-stock-api/suppliers.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.