vendors

Get Vendor

Retrieve a specific vendor by ID.

get/vendors/{vendor_id}

Request

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

Path parameters

vendor_idstring required

Query parameters

include_contactsboolean

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

Response

Vendor details

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.