vendors

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)
get/vendors

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/vendors
  • Auth: API key in header x-api-key

Query parameters

page_sizeinteger

Number of items per page (max 100)

pageinteger

Page number (1-based)

string date
OR
string date-time

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

string date
OR
string date-time

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

order_by'asc' | 'desc'

Sort order for results

include_archivedboolean

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

include_contactsboolean

Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.

vendor_type'CONSULTANT' | 'FINANCING' | 'LOGISTICS' | 'MANUFACTURER' | 'SUBCONTRACTOR' | 'SUPPLIER'

Filter by vendor type

Response

List of vendors

idinteger

Unique identifier

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

namestring

Vendor name

descriptionstring nullable

Vendor description

addressstring[]

Vendor location/address

isActiveboolean

Whether the vendor is active

primaryEmailstring email nullable

Primary contact email

primaryPhonestring nullable

Primary contact phone

numberinteger

Vendor number (e.g., 1234)

vendorType'CONSULTANT' | 'FINANCING' | 'LOGISTICS' | 'MANUFACTURER' | 'SUBCONTRACTOR' | 'SUPPLIER'

The type of vendor

websitestring nullable

Vendor website URL

projectIdsinteger[]

IDs of projects this vendor is linked to

customobject

Custom fields

Changes

No recorded changes to this operation across all 1 revision of this API.