Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Query Parameters

q
string | null

Suppliers whose code starts with it, or whose name holds it.

Maximum string length: 100
archived
boolean | null

Archived suppliers instead of active ones.

after
string | null

The next_cursor of the page before.

Maximum string length: 32

Response

SupplierPageResource

data
SupplierPageResource · object
required