Get Vendor | Coperniq API

Retrieve a specific vendor by ID.

x-api-keystring

API Key authentication via header

vendor_idstringRequired

include_contactsbooleanOptionalDefaults to false

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

Vendor details

idintegerOptional

Unique identifier

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

namestringOptional

Vendor name

descriptionstring or nullOptional

Vendor description

addresslist of stringsOptional

Vendor location/address

isActivebooleanOptional

Whether the vendor is active

primaryEmailstring or nullOptionalformat: "email"

Primary contact email

primaryPhonestring or nullOptional

Primary contact phone

numberintegerOptional

Vendor number (e.g., 1234)

vendorTypeenum or nullOptional

The type of vendor

websitestring or nullOptional

Vendor website URL

projectIdslist of integersOptional

IDs of projects this vendor is linked to

custommap from strings to anyOptional

Custom fields

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/vendors/vendor_id';
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	}