Contacts

List contacts

Retrieve contacts using pagination and optional lifecycle filtering.

Overview

Use this API to retrieve contacts using pagination and optional lifecycle filtering. It requires bearer api key authentication and the contacts:read scope.

GET/contacts

cURL

GET

bash

curl --request GET \  --url 'https://api.atlascrm.dev/v1/contacts?limit=25&lifecycleStage=customer' \  --header 'Authorization: Bearer crm_live_xxx'

Authorization

Bearer API key

contacts:read

Sample Request Body

This endpoint does not require a request body.

Sample Response

json

{  "status": "success",  "data": [    {      "id": "con_123",      "email": "maya@example.com",      "firstName": "Maya",      "lifecycleStage": "customer"    }  ],  "pagination": {    "nextCursor": "eyJpZCI6ImNvbl8xMjMifQ"  }}

Status Codes

Code	Description
200	Contacts were returned.

Headers

AuthorizationstringRequired

Bearer token for your workspace.

Example: Bearer crm_live_xxx

Object	Description
Authorization string	RequiredBearer token for your workspace. Example: Bearer crm_live_xxx

Query parameters

limitintegerOptional

Number of records to return.

Example: 25

cursorstringOptional

Cursor returned from the previous page.

lifecycleStagestringOptional

Filter contacts by lifecycle stage.

Example: customer

Object	Description
limit integer	OptionalNumber of records to return. Example: 25
cursor string	OptionalCursor returned from the previous page.
lifecycleStage string	OptionalFilter contacts by lifecycle stage. Example: customer

Response fields

dataContact[]

List of contact records.

pagination.nextCursorstring | null

Cursor for the next page.

Object	Description
data Contact[]	List of contact records.
pagination.nextCursor string \| null	Cursor for the next page.