Get contacts by time filters

[ { "id": "df980fc8-b6db-4820-bf22-2969482d106d", "name": "John Doe", "phone": "+56912345678", "email": "john@example.com", "platform": "whatsapp", "last_message_at": "2024-09-30T10:00:00.000Z", "chat_status": "ATTENDED", "created_at": "2024-01-15T10:00:00.000Z", "updated_at": "2024-01-16T09:30:00.000Z", "client_id": "123e4567-e89b-12d3-a456-426614174000", "ai_customer_id": "123e4567-e89b-12d3-a456-426614174000", "default_stage_id": "123e4567-e89b-12d3-a456-426614174000", "blocked": false, "is_chat_read": true, "active_ticket_v2": { "id": "123e4567-e89b-12d3-a456-426614174000", "current_stage_id": "123e4567-e89b-12d3-a456-426614174000" } } ]

Headers

x-api-key

string

required

API key needed to authorize the request

Query Parameters

days

number

Filter contacts whose last message was within this many days (1-365)

Required range: 1 <= x <= 365

Example:

30

created_after

string<date-time>

Return only contacts created strictly after this ISO 8601 timestamp. Use for syncing newly created contacts.

Example:

"2024-01-15T10:00:00.000Z"

updated_after

string<date-time>

Return only contacts updated strictly after this ISO 8601 timestamp. Use as a sync cursor to pull both new and modified contacts since the last poll.

Example:

"2024-01-15T10:00:00.000Z"

limit

number

Maximum number of contacts to return (1-1000)

Required range: 1 <= x <= 1000

Example:

100

offset

number

Number of contacts to skip, for pagination

Required range: x >= 0

Example:

0

stage_id

string<uuid>

Stage ID to filter contacts

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

pipeline_id

string<uuid>

Pipeline ID to filter contacts by their active ticket stage

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

custom_field_key

string

The key of the custom field to filter by. Must be provided together with custom_field_value.

Minimum string length: 1

Example:

"status"

custom_field_value

string

The value to match for the custom field. Must be provided together with custom_field_key.

Minimum string length: 1

Example:

"Active"

entity_type

enum<string>

Specify "ticket" or "customer" to filter only by custom fields of that entity type. Only applies when custom_field_key and custom_field_value are provided.

Available options:

ticket,

customer

Response

Contacts retrieved successfully.

string

Example:

"df980fc8-b6db-4820-bf22-2969482d106d"

name

string

Example:

"John Doe"

phone

string

Example:

"+56912345678"

string

Example:

"john@example.com"

platform

string

Example:

"whatsapp"

last_message_at

string

Example:

"2024-09-30T10:00:00.000Z"

chat_status

string

Example:

"ATTENDED"

created_at

string

Example:

"2024-01-15T10:00:00.000Z"

updated_at

string

Example:

"2024-01-16T09:30:00.000Z"

client_id

string

Example:

"123e4567-e89b-12d3-a456-426614174000"

ai_customer_id

string | null

Example:

"123e4567-e89b-12d3-a456-426614174000"

default_stage_id

string | null

Example:

"123e4567-e89b-12d3-a456-426614174000"

blocked

boolean

Example:

false

is_chat_read

boolean

Example:

true

active_ticket_v2

object

Show child attributes