Get Account | Coperniq API

Retrieve a specific account by ID

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

Path parameters

accountIdintegerRequired

Account identifier

Query parameters

include_virtual_propertiesbooleanOptionalDefaults to false

Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.

include_contactsbooleanOptionalDefaults to false

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

include_archivedbooleanOptionalDefaults to false

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

Response

Account details

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

401

Unauthorized Error

404

Not Found Error

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