API ReferenceVendors

List Vendors

Retrieve a paginated list of vendors. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`, default: desc) - Vendor type filter (`vendor_type`)

Authentication

x-api-keystring
API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

order_byenumOptionalDefaults to asc
Sort order for results
Allowed values:
include_archivedbooleanOptionalDefaults to false

Whether to include archived (inactive) records in the response. By default only active records are returned.

include_contactsbooleanOptionalDefaults to false
Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.
vendor_typeenumOptional
Filter by vendor type

Response

List of vendors
idinteger
Unique identifier
createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
namestring
Vendor name
descriptionstring or null
Vendor description
addresslist of strings

Vendor location/address

isActiveboolean
Whether the vendor is active
primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
numberinteger

Vendor number (e.g., 1234)

vendorTypeenum or null
The type of vendor
websitestring or null
Vendor website URL
projectIdslist of integers
IDs of projects this vendor is linked to
custommap from strings to any
Custom fields

Errors

401
Unauthorized Error