Get Vendor | Coperniq API

Retrieve a specific vendor by ID.

x-api-keystring

API Key authentication via header

vendorIdstringRequired

include_contactsbooleanOptionalDefaults to false

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

Vendor details

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

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/vendors/vendorId';
2	const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}