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_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, 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 within the workspace's available capabilities.

Query Parameters

view_id
string<uuid>

Apply a saved History view (GET /history/views). Filter parameters you also send override the view's values; the period (date_range, from, to) and the duration bounds are each replaced as a whole.

type
enum<string>[]

Filter by channel: matches the channel field of each row. avatar = web voice with virtual avatar; live_chat = widget text chat; messaging channels (chat apps, help desks, mailboxes) query messaging conversations. Comma-separated list, any of (e.g. call,whatsapp_voice).

Available options:
sms,
call,
avatar,
email,
live_chat,
whatsapp_voice,
whatsapp,
telegram,
slack,
messenger,
teams,
discord,
gchat,
x,
freshdesk,
gmail,
outlook,
zendesk,
servicenow,
intercom,
zoho_mail,
agent_mail,
instagram,
zulip
direction
enum<string>[]

Filter by direction. Comma-separated list, any of. web applies only to calls.

Available options:
inbound,
outbound,
web
status
enum<string>[]

Filter by normalized status. Comma-separated list, any of (e.g. no_answer,busy,failed).

Available options:
queued,
ringing,
in_progress,
completed,
failed,
no_answer,
busy,
skipped
assistant_id
string<uuid>[]

Filter calls, messaging and emails by assistant. Comma-separated list of assistant IDs, any of (max 50).

campaign_id
string<uuid>[]

Filter by campaign; campaign history contains calls only. Comma-separated list of campaign IDs, any of (max 50).

lead_id
string<uuid>

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

tags
string

Filter by Audience contact tags. Comma-separated; conversations whose contact has any of these tags are included.

sentiment
enum<string>[]

Filter by analysis sentiment (calls, messaging and email threads with a completed analysis). Comma-separated list, any of.

Available options:
positive,
neutral,
negative
outcome
enum<string>

Filter by the analysis success verdict. Conversations without a verdict are excluded.

Available options:
successful,
unsuccessful
qa
enum<string>

Filter calls by their AI QA scorecard result. Requires the AI QA Scorecards feature; returns calls only.

Available options:
passed,
failed
min_duration
integer

Minimum duration in seconds, inclusive. Returns calls only (messaging and email have no duration).

Required range: x >= 0
max_duration
integer

Maximum duration in seconds, inclusive. Returns calls only.

Required range: x >= 0

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

date_range
enum<string>

Relative period in the workspace timezone; the last-N-days ranges include today. Saved views keep it relative, so it moves with the current date. Cannot be combined with from/to.

Available options:
today,
yesterday,
last_7_days,
last_30_days,
last_90_days,
this_month,
last_month
from
string

Only entries active at or after this time (latest message time for email threads). ISO 8601 date-time, or a calendar date YYYY-MM-DD that starts in the workspace timezone. Cannot be combined with date_range.

to
string

Only entries active at or before this time (latest message time for email threads). ISO 8601 date-time, or a calendar date YYYY-MM-DD that includes that whole day in the workspace timezone. Cannot be combined with date_range.

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