Search Vendors | Coperniq API

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)

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

Authentication

x-api-keystring

API Key authentication via header

Query parameters

prop1stringRequired

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

op1enumRequired

Operator for prop1

value1stringRequired

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

logicenumOptionalDefaults to and

Logical combination when both prop1 and prop2 are provided

Allowed values:

prop2stringOptional

Optional second field to filter

op2enumOptional

Operator for prop2

value2stringOptional

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

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

include_archivedbooleanOptionalDefaults to false

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

Response

Matching 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

400

Bad Request Error

401

Unauthorized Error

1	const url = 'https://api.coperniq.io/v1/vendors/search?prop1=prop1&op1=eq&value1=value1';
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	]