Get Account

GET

https://api.coperniq.io/v1/accounts/:account_id

GET

/v1/accounts/:account_id

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   "createdBy": {
15     "id": 1,
16     "firstName": "string",
17     "lastName": "string",
18     "email": "string",
19     "avatarUrl": "string"
20   },
21   "updatedBy": {
22     "id": 1,
23     "firstName": "string",
24     "lastName": "string",
25     "email": "string",
26     "avatarUrl": "string"
27   },
28   "custom": {},
29   "accountType": "RESIDENTIAL",
30   "contacts": [
31     {
32       "id": 1,
33       "name": "string",
34       "title": "string",
35       "description": "string",
36       "emails": [
37         "string"
38       ],
39       "phones": [
40         "string"
41       ],
42       "isPrimary": true
43     }
44   ]
45 }

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

account_idintegerRequired

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

idintegerOptional

Unique identifier

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Timestamp of the most recent update to the record, including changes to its custom property values.

titlestringOptional

Record title/name

descriptionstring or nullOptional

Record description

addresslist of stringsOptional

Record location/address

isActivebooleanOptional

Whether the record is active

primaryEmailstring or nullOptionalformat: "email"

Primary contact email

primaryPhonestring or nullOptional

Primary contact phone

numberintegerOptional

Record number (e.g., 1234)

createdByobject or nullOptional

User who created the record. Null when the record was created by a non-user actor (e.g. automation or a contact).

updatedByobject or nullOptional

User who last edited a field on the record, derived from the changelog. Null when the record has never been edited or the last edit was made by a non-user actor.

custommap from strings to anyOptional

Custom fields

accountTypeenum or nullOptional

Type of account (residential or commercial)

contactslist of objectsOptional

On GET requests, only populated when include_contacts=true is passed. Always populated on POST (create) and PATCH (update) responses. Ordered with the primary contact first, capped at 20 contacts.

Errors

401

Unauthorized Error

404

Not Found Error