accounts

List Accounts

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.

get/accounts

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/accounts
  • Auth: API key in header x-api-key

Query parameters

page_sizeinteger

Number of items per page (max 100)

pageinteger

Page number (1-based)

string date
OR
string date-time

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

string date
OR
string date-time

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

order_by'asc' | 'desc'

Sort order for results

include_virtual_propertiesboolean

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

include_contactsboolean

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

include_archivedboolean

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

qstring

Full text search query

titlestring

Title search query

addressstring

Address search query

primaryNamestring

Contact name search query

primaryPhonestring

Contact phone search query

primaryEmailstring

Contact email search query

Response

List of accounts

idinteger

Unique identifier

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

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

titlestring

Record title/name

descriptionstring nullable

Record description

addressstring[]

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring email nullable

Primary contact email

primaryPhonestring nullable

Primary contact phone

numberinteger

Record number (e.g., 1234)

customobject

Custom fields

accountType'RESIDENTIAL' | 'COMMERCIAL'

Type of account (residential or commercial)

Changes

No recorded changes to this operation across all 1 revision of this API.