Skip to main content
GET
List conversation history

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Query Parameters

type
enum<string>

Filter by conversation type. avatar = web voice with virtual avatar; live_chat = widget text chat; messaging platforms query messaging conversations.

Available options:
call,
avatar,
email,
live_chat,
whatsapp_voice,
whatsapp,
telegram,
slack,
messenger,
teams,
discord,
gchat,
x
direction
enum<string>

Filter by direction. web applies only to calls.

Available options:
inbound,
outbound,
web
status
enum<string>
Available options:
queued,
ringing,
in_progress,
completed,
failed,
no_answer,
busy,
skipped
assistant_id
string<uuid>

Filter calls and emails by assistant.

campaign_id
string<uuid>

Filter by campaign; campaign history contains calls only.

lead_id
string<uuid>

Filter the unified history by one Audience contact across calls, messaging and email.

Search phone numbers, email addresses, email subject/body, and call summaries.

from
string<date-time>

Only entries active at or after this ISO 8601 date/datetime (latest message time for email threads).

to
string<date-time>

Only entries active at or before this ISO 8601 date/datetime (latest message time for email threads).

limit
integer
default:50

Page size (1–200).

Required range: 1 <= x <= 200
offset
integer
default:0

Number of items to skip.

Required range: x >= 0

Response

A globally sorted page of calls and emails.

data
object[]
required
meta
object