vendors

Search Vendors

Search vendors using up to two filters (prop1/op1/value1 and optionally prop2/op2/value2), combined with logic (AND/OR).

Properties:

  • propX can be a standard field (e.g., name, website, vendorType) or a custom property key name.

Operators (opX):

  • Equality: eq, neq
  • Text/string matching: contains (case-insensitive)
  • Lists: in, nin (CSV list in valueX)
get/vendors/search

Request

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

Query parameters

prop1string required

First field to filter (e.g. name, vendorType, website or custom keyName)

op1'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'in' | 'nin' | 'between' required

Operator for prop1

value1string required

Value for prop1 (comma-separated values for in/nin or between)

logic'and' | 'or'

Logical combination when both prop1 and prop2 are provided

prop2string

Optional second field to filter

op2'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'in' | 'nin' | 'between'

Operator for prop2

value2string

Value for prop2 (comma-separated values for in/nin or between)

page_sizeinteger

Number of items per page (max 100)

pageinteger

Page number (1-based)

include_archivedboolean

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

Response

Matching 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.