List Suppliers

Returns the company's suppliers as a paginated list, newest first. Requires the Read Suppliers permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 1

Page number.

integer
Defaults to 20

Page size.

string

Sort field, e.g. name, name:asc or name:desc.

boolean

Set 1 to return all rows without the pagination envelope (rejected when the result set exceeds the server's row cap).

string

Filter by supplier name (substring match). The response's search object also advertises a q_created_at date-range filter.

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json