List Vendors | Coperniq API

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)

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`)

Authentication

x-api-keystring

API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptional

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

updated_beforestringOptional

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

order_byenumOptionalDefaults to asc

Sort order for results

Allowed values:

include_archivedbooleanOptionalDefaults to false

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

include_contactsbooleanOptionalDefaults to false

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

vendor_typeenumOptional

Filter by vendor type

Response

List of vendors

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

Errors

401

Unauthorized Error

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

1	[
2	{
3	"id": 1,
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-01-15T09:30:00Z",
6	"name": "string",
7	"description": "string",
8	"address": [
9	"string"
10	],
11	"isActive": true,
12	"primaryEmail": "string",
13	"primaryPhone": "string",
14	"number": 1,
15	"vendorType": "CONSULTANT",
16	"website": "string",
17	"projectIds": [
18	1
19	],
20	"custom": {}
21	}
22	]