/api/v3/vendors

Get a paginated list of vendors with optional filtering

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

Filter by vendor type code (A, E, I, L, T, etc.)

string
enum
Defaults to active

Filter by vendor status

Allowed:
string
enum
Defaults to list

Response format (list, table, or csv)

Allowed:
integer
Defaults to 1

Page number for pagination

integer
Defaults to 20

Number of items per page

Search text to filter vendors by name, contact_name, contact_email, or contact_phone (partial match, case-insensitive)

string
enum

Column to sort by. Available columns: vendor_id, name, vendor_type, contact_name, contact_email, contact_phone, preferred, status, added (created_ts), updated (updated_ts), tin, address (address_1), allow_platform_access. Defaults to 'name' if not specified or invalid.

string
enum
Defaults to asc

Sort direction: 'asc' for ascending or 'desc' for descending

Allowed:
Headers
integer
required

Team ID of currently selected team

Response

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