contacts

List Contacts

Retrieve a paginated list of contacts.

Supports:

  • Pagination (page_size, page)
  • Date filtering (updated_after, updated_before)
  • Sorting (order_by)
  • Search (q)
get/contacts

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/contacts
  • 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

qstring

Full text search across contact name, emails, and phones.

Response

List of contacts

idinteger

Unique identifier

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

namestring required

Contact's full name

phonesstring[]

List of contact phone numbers

emailsstring[]

List of contact email addresses

titlestring nullable

Contact title

descriptionstring nullable

Contact description

Changes

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