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., title, 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., `title`, `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. title, 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

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Record title/name

descriptionstring or null

Record description

addresslist of strings

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Record number (e.g., 1234)

custommap from strings to any

Custom fields

vendorTypeenum or null

The type of vendor

websitestring or null

Vendor website URL

projectIdslist of integers

IDs of projects this vendor is linked to

Errors

400

Bad Request Error

401

Unauthorized Error

1	const url = 'https://api.coperniq.io/v1/vendors/search?prop1=vendorType&op1=eq&value1=SUPPLIER&logic=and&prop2=title&op2=contains&value2=energy';
2	const options = {
3	method: 'GET',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	[
2	{
3	"id": 1024,
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-04-10T11:45:00Z",
6	"title": "Green Energy Supplies",
7	"description": "Supplier of renewable energy components and materials",
8	"address": [
9	"123 Solar Way",
10	"Suite 400",
11	"San Francisco, CA 94105"
12	],
13	"isActive": true,
14	"primaryEmail": "contact@greenenergysupplies.com",
15	"primaryPhone": "+1-415-555-0198",
16	"number": 4587,
17	"custom": {
18	"certification": "ISO 14001",
19	"region": "West Coast"
20	},
21	"vendorType": "SUPPLIER",
22	"website": "https://www.greenenergysupplies.com",
23	"projectIds": [
24	301,
25	302,
26	305
27	]
28	}
29	]