List Distributors

Retrieves a paginated list of the Distributors on the calling Account,
disabled ones included, newest first unless sort says otherwise. Filter on
enabled before using one for pricing and availability lookups.

Credentials are write-only, for security: no entry carries them, not even
encrypted. fields narrows every entry to the fields asked for;
next_cursor and total_count are always returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^(enabled|id|label|name|record_created_at|record_updated_at)(,(enabled|id|label|name|record_created_at|record_updated_at))*$

One or more response fields. Accepts multiple comma-separated values.
Fields not named are omitted from each Distributor in the body.

Examples

  • fields=id,name,enabled
string

The pointer used to fetch a certain page of records. Pass the next_cursor of the previous page.

string
enum
^(eq):.+$

Filter by enabled.

Operators: eq

Examples

  • filter[enabled]=eq:true
Allowed:
string
^(eq|in):.+$

Filter by id. in accepts a comma-separated list.

Operators: eq, in

Examples

  • filter[id]=eq:conn_2uBmQcMgHinlJgyv4or3dCKwWIb
  • filter[id]=in:conn_2uBmQcMgHinlJgyv4or3dCKwWIb,conn_2uBmQnQd7bXl6Hk1Ty2oZp9cA3E
string
^(eq|in):.+$

Filter by name. in accepts a comma-separated list. A value that is not
a supported name matches nothing.

Operators: eq, in

Examples

  • filter[name]=eq:dandh
  • filter[name]=in:dandh,synnex
int32
1 to 200
Defaults to 200

The number of records to be returned in a single page, from 1 to 200. Defaults to 200.

string
^[+-]?(record_created_at|record_updated_at)(,[+-]?(record_created_at|record_updated_at))*$

One or more sort fields, separated by commas. Prefix a field with - for
descending or + for ascending order. Allowed fields are
record_created_at and record_updated_at. Defaults to -record_created_at.

Responses

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