Search Accounts | Coperniq API

Search accounts 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., status, title, city, type, etc.) or a custom property key name.
Use the property key from your company settings.

Operators (opX):

Equality: eq, neq
Numeric/datetime comparisons: gt, gte, lt, lte
Text/string matching: contains (case-insensitive)
Lists: in, nin (CSV list in valueX)
Ranges: between (use valueX as from,to)
Existence: exists is not supported for custom properties due to performance limitations. Use eq or neq instead.

Value formats:

in/nin: lists can be provided as:
- Plain CSV: value1=OPEN,ACTIVE
- Quoted CSV (to include commas inside a value): value1="Last, First",Other
- JSON array: value1=["Last, First","Other"]
between: from,to (e.g., value1=2025-01-01,2025-12-31 or value1=10,20)
Dates should be ISO 8601 strings; numeric-like values on custom properties are matched against both numeric and text representations.

Examples:

status equals ACTIVE: ?prop1=status&op1=eq&value1=ACTIVE
custom id equals 1234: ?prop1=legacy_tool_project_id&op1=eq&value1=1234
title contains “Solar”: ?prop1=name&op1=contains&value1=Solar
status IN (ACTIVE, ON_HOLD) AND city = Austin: ?prop1=status&op1=in&value1=ACTIVE,ON_HOLD&logic=and&prop2=city&op2=eq&value2=Austin

Note: The /clients path is an alias for /accounts and will continue to work until users are individually notified and migrated.

Search accounts 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., `status`, `title`, `city`, `type`, etc.) or a custom property key name. - Use the `property key` from your company settings. Operators (`opX`): - Equality: `eq`, `neq` - Numeric/datetime comparisons: `gt`, `gte`, `lt`, `lte` - Text/string matching: `contains` (case-insensitive) - Lists: `in`, `nin` (CSV list in `valueX`) - Ranges: `between` (use `valueX` as `from,to`) - Existence: `exists` is not supported for custom properties due to performance limitations. Use `eq` or `neq` instead. Value formats: - `in`/`nin`: lists can be provided as: - Plain CSV: `value1=OPEN,ACTIVE` - Quoted CSV (to include commas inside a value): `value1="Last, First",Other` - JSON array: `value1=["Last, First","Other"]` - `between`: `from,to` (e.g., `value1=2025-01-01,2025-12-31` or `value1=10,20`) - Dates should be ISO 8601 strings; numeric-like values on custom properties are matched against both numeric and text representations. Examples: - status equals ACTIVE: `?prop1=status&op1=eq&value1=ACTIVE` - custom id equals 1234: `?prop1=legacy_tool_project_id&op1=eq&value1=1234` - title contains "Solar": `?prop1=name&op1=contains&value1=Solar` - status IN (ACTIVE, ON_HOLD) AND city = Austin: `?prop1=status&op1=in&value1=ACTIVE,ON_HOLD&logic=and&prop2=city&op2=eq&value2=Austin` **Note:** The `/clients` path is an alias for `/accounts` and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

prop1stringRequired

First field to filter (standard or custom keyName)

op1enumRequired

Operator for prop1

value1stringRequired

Value for prop1 (CSV for in/nin, from,to for 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 (CSV for in/nin, from,to for between)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

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.

Response

List of accounts matching filters

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

accountTypeenum or null

Type of account (residential or commercial)

Allowed values:

contactslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

Search accounts 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., status, title, city, type, etc.) or a custom property key name.
Use the property key from your company settings.

Operators (opX):

Equality: eq, neq
Numeric/datetime comparisons: gt, gte, lt, lte
Text/string matching: contains (case-insensitive)
Lists: in, nin (CSV list in valueX)
Ranges: between (use valueX as from,to)
Existence: exists is not supported for custom properties due to performance limitations. Use eq or neq instead.

Value formats:

in/nin: lists can be provided as:
- Plain CSV: value1=OPEN,ACTIVE
- Quoted CSV (to include commas inside a value): value1="Last, First",Other
- JSON array: value1=["Last, First","Other"]
between: from,to (e.g., value1=2025-01-01,2025-12-31 or value1=10,20)
Dates should be ISO 8601 strings; numeric-like values on custom properties are matched against both numeric and text representations.

Examples:

status equals ACTIVE: ?prop1=status&op1=eq&value1=ACTIVE
custom id equals 1234: ?prop1=legacy_tool_project_id&op1=eq&value1=1234
title contains “Solar”: ?prop1=name&op1=contains&value1=Solar
status IN (ACTIVE, ON_HOLD) AND city = Austin: ?prop1=status&op1=in&value1=ACTIVE,ON_HOLD&logic=and&prop2=city&op2=eq&value2=Austin

Note: The /clients path is an alias for /accounts and will continue to work until users are individually notified and migrated.

1	const url = 'https://api.coperniq.io/v1/accounts/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	"title": "string",
7	"description": "string",
8	"address": [
9	"string"
10	],
11	"isActive": true,
12	"primaryEmail": "string",
13	"primaryPhone": "string",
14	"number": 1,
15	"custom": {},
16	"accountType": "RESIDENTIAL",
17	"contacts": [
18	{
19	"id": 1,
20	"emails": [
21	"string"
22	],
23	"phones": [
24	"string"
25	]
26	}
27	]
28	}
29	]