Skip to main content
GET
Returns unified customer profiles (one row per person) with conversation stats.

Authentication

X-API-Key
string
required
Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id
string
required
Organization ID. Must match the API key.
project_id
string
required
Project ID. Must match the API key.

Query parameters

skip
integer
default:"0"
Number of records to skip.
limit
integer
default:"20"
Page size. Range: 11000.
Search by name, email, phone, or display id.
channel
string
Filter by channel_type identity.
sort_field
string
default:"last_interaction_at"
Field to sort by.
sort_order
integer
default:"-1"
1 ascending, -1 descending.
date_from
datetime
Filter by interaction/activity from this datetime.
date_to
datetime
Filter by interaction/activity until this datetime.

Response

items
array
required
Customer profile objects with phones, emails, channel identities, properties, and counts.
pagination
object
required
Pagination metadata.

Errors

401
Unauthorized
Missing, invalid, or revoked API key.
403
Forbidden
API key is not authorized for this organization or project.