Sign in
email

List Email Threads

Paginated, filterable list of email threads (newest activity first).

get/email/threads

Query parameters

sourcestring nullable
contact_sourcestring nullable
account_idstring uuid nullable
include_spamboolean

Include threads the source marked as spam

Include threads the source marked as spam

local_hour_of_dayinteger nullable

Filter to threads stamped at this tenant-local hour (0-23); heatmap cell drill.

Filter to threads stamped at this tenant-local hour (0-23); heatmap cell drill.

local_day_of_weekinteger nullable

Filter to threads stamped on this tenant-local weekday (0=Mon..6=Sun); heatmap cell drill.

Filter to threads stamped on this tenant-local weekday (0=Mon..6=Sun); heatmap cell drill.

limitinteger nullable
offsetinteger nullable
pageinteger nullable

Deprecated - use offset.

Deprecated - use offset.

per_pageinteger nullable

Deprecated - use limit.

Deprecated - use limit.

start_datestring date nullable
end_datestring date nullable
date_fieldstring nullable

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

date_fromstring date-time nullable

Deprecated - use start_date.

Deprecated - use start_date.

date_tostring date-time nullable

Deprecated - use end_date.

Deprecated - use end_date.

use_created_atboolean nullable

Deprecated - use date_field=created_at.

Deprecated - use date_field=created_at.

property_idsstring[] nullable
property_ids_excludestring[] nullable
include_considered_hotelsboolean nullable

Include hotels the conversation was only considered for, not just the one it was attributed to.

Include hotels the conversation was only considered for, not just the one it was attributed to.

agent_idstring uuid nullable
outcome_agent_refstring nullable
outcome_agent_refsstring[] nullable
outcome_agent_refs_excludestring[] nullable
outcome_agent_kind'ai_voice' | 'ai_text' | 'human' nullable
reviewedboolean nullable
statusstring nullable
has_booking_intentboolean nullable
has_bookingboolean nullable
booking_madeboolean nullable
booking_attributedboolean nullable
tag_idsstring[] nullable
countrystring nullable
is_after_hoursboolean nullable
population_filtersstring[] nullable

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

searchstring nullable
standard_filtersstring nullable
metric_filtersstring nullable
sort_bystring nullable
sort_order'asc' | 'desc' nullable
strictboolean

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

voice_agent_idstring uuid nullable

Deprecated - use agent_id.

Deprecated - use agent_id.

metric_idstring uuid nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

metric_state'pass' | 'fail' | 'na' | 'not_run' | 'error' nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

booking_intentboolean nullable

Deprecated - use has_booking_intent.

Deprecated - use has_booking_intent.

Response

Successful Response

totalinteger required

Rows matching the filters, in total_units.

limitinteger required

Page size actually applied.

offsetinteger required

Rows skipped.

has_moreboolean required

Whether another page exists.

total_unit'logical_call' | 'row'

What total counts. row for text, email and bookings. voice returns logical_call, because a transferred call is several legs in items but one call in total — so a caller that counts items will legitimately disagree with total.

applied_filtersstring[]

Filters that were compiled into the query.

pageinteger nullable

Deprecated — derive from offset/limit.

per_pageinteger nullable

Deprecated — use limit.

Changes

No recorded changes to this endpoint across all 1 revision of this API.