List vendors

Vendors are read-only. Only GET method is supported. Other methods are disabled. Deleted vendors are left out unless they are named by ID or by code.

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

Database ID of the vendor. One value or a list, for example ?vendor_id=10 or ?vendor_id[]=10&vendor_id[]=20. Deleted vendors are returned when their ID is named.

string | null

A unique number to identify the vendor. Partial match. Deleted vendors are returned when their code matches.

string | null

Name of the vendor. Partial match.

string | null

Phone number from vendor contact data. Partial match.

string | null

Teams ID from vendor contact data. Partial match.

string | null

Email address from vendor contact data. Partial match.

string | null

Website address from vendor contact data. Partial match.

string | null

Address from vendor contact data. Partial match. Searches the general address only, and matches a country by its name or its two- or three-letter ISO code as well.

integer | null

Database ID of the default currency of the vendor. Zero stands for the account's base currency.

integer | null

Minimum default lead time of the vendor in days. Inclusive.

integer | null

Maximum default lead time of the vendor in days. Inclusive.

custom_values
array of objects | null

Conditions on custom fields of the vendor. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

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