List Contacts | Coperniq API

const url = 'https://api.coperniq.io/v1/contacts';
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);
}

[
  {
    "name": "Jordan Lee",
    "phones": [
      "+14155550123"
    ],
    "emails": [
      "jordan.lee@example.com"
    ],
    "title": "Project Coordinator",
    "createdByUser": {
      "id": 42
    },
    "accounts": [
      {
        "id": 101,
        "title": "Acme Solar"
      }
    ],
    "projects": [
      {
        "id": 501,
        "title": "Smith Residence"
      }
    ]
  },
  {
    "name": "Casey Morgan",
    "phones": [
      "+14155550987"
    ],
    "emails": [
      "casey.morgan@example.com"
    ],
    "title": "Account Manager",
    "createdByUser": {
      "id": 42
    },
    "accounts": [
      {
        "id": 102,
        "title": "Bright Electric"
      }
    ],
    "projects": [
      {
        "id": 502,
        "title": "Riverside Retrofit"
      }
    ]
  }
]

Retrieve a paginated list of contacts.

Supports:

Pagination (page_size, page)
Date filtering (updated_after, updated_before)
Sorting (order_by)
Search (q)

Retrieve a paginated list of contacts. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`) - Search (`q`)

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:

qstringOptional

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

Response

List of contacts

namestring

Contact's full name

idintegerOptional

Unique identifier

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

phoneslist of stringsOptional

List of contact phone numbers

emailslist of stringsOptional

List of contact email addresses

titlestring or nullOptional

Contact title

descriptionstring or nullOptional

Contact description

createdByUserobjectOptional

accountslist of objectsOptional

List of linked accounts

projectslist of objectsOptional

List of linked projects

opportunitieslist of objectsOptional

List of linked opportunities

vendorslist of objectsOptional

List of linked vendors

Errors

401

Unauthorized Error