accounts

Get Account

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.

get/accounts/{account_id}

Request

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

Path parameters

account_idinteger required

Account identifier

Query parameters

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.

Response

Account details

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.