List Accounts | Coperniq API

const url = 'https://api.coperniq.io/v1/accounts';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "title": "string",
    "description": "string",
    "address": [
      "string"
    ],
    "isActive": true,
    "primaryEmail": "string",
    "primaryPhone": "string",
    "number": 1,
    "createdBy": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "avatarUrl": "string"
    },
    "updatedBy": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "avatarUrl": "string"
    },
    "custom": {},
    "accountType": "RESIDENTIAL",
    "contacts": [
      {
        "id": 1,
        "name": "string",
        "title": "string",
        "description": "string",
        "emails": [
          "string"
        ],
        "phones": [
          "string"
        ],
        "isPrimary": true
      }
    ]
  }
]

Retrieve a paginated list of accounts.

Supports:

Pagination (page_size, page)
Date filtering (updated_after, updated_before)
Sorting (order_by, default: desc)
Field search (title, address, primaryName, primaryPhone, primaryEmail)
Full text search (q)

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

Retrieve a paginated list of accounts. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`, default: desc) - Field search (`title`, `address`, `primaryName`, `primaryPhone`, `primaryEmail`) - Full text search (`q`) **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

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptional

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

updated_beforestringOptional

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

order_byenumOptionalDefaults to asc

Sort order for results

Allowed values:

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.

qstringOptional

Full text search query

titlestringOptional

Title search query

addressstringOptional

Address search query

primaryNamestringOptional

Contact name search query

primaryPhonestringOptional

Contact phone search query

primaryEmailstringOptional

Contact email search query

Response

List of accounts

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