List suppliers
GET/v1/entities/:entity_id/suppliers
Returns the suppliers of the key's store, including hidden ones unless you send
hidden=false.
Requires the suppliers:read scope.
The response is a plain JSON object. The root key is suppliers; pagination lives in meta
(page, per_page, total). Results are returned in the order the suppliers were created,
oldest first.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 504
A page of suppliers.
updated_after is not a valid date, or hidden or search was sent as a list instead of one value.
The Authorization header is missing, is not HTTP Basic, or does not carry a valid API key. Create and manage keys under Settings → API keys in the Bookkeep section of the Bookkeep app.
The key does not hold suppliers:read, or the key's store is not linked to {entity_id}.
Rate limit reached. The inventory endpoints share one limit of 60 requests per minute per source IP address, counted across Purchase Orders, Suppliers, Receipts and Bills. The count resets at the start of each minute. No Retry-After header is sent. The body is JSON only when the request sends Accept: application/json; otherwise it is an HTML page.
The service did not respond in time. This is a read, so it is safe to retry after a short wait.