Skip to main content
GET
Get all conversations

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
scope
string | null

Which conversations to list: assigned for the ones whose lead is assigned to you, all (the default) for every conversation you may see. Without permission to view all conversations the list is always assigned.

search
string | null

The search query.

Maximum string length: 255
channel_type
enum<string> | null

Filter by channel type (whatsapp, instagram, etc.).

Mevcut seçenekler:
whatsapp,
instagram,
website,
telegram,
null
channel_ids[]
integer[]

A channel ID to filter by.

archived
boolean | null

Filter by archive state. Pass true for archived conversations only, false for active ones. Defaults to active conversations when omitted.

archive_states[]
string[]

An archive state: "active" or "archived".

lead_reference_source_ids[]
integer[]

A lead reference source ID to filter by.

assigned_user_ids[]
integer[]

A user ID to filter by.

tags[]
integer[]

A tag ID to filter by.

archived_at_from
string<date-time> | null

Only include conversations archived at or after this date.

archived_at_to
string<date-time> | null

Only include conversations archived at or before this date.

lead
enum<string> | null

Filter by customer stage. Pass "lead" for conversations whose customer is still a lead, or "patient" for converted customers. Omit for all.

Mevcut seçenekler:
lead,
patient,
null
has_open_task
boolean | null

Filter by open tasks of the customer, including the tasks added on its lead. Pass true for conversations with at least one open task, false for conversations without any.

group_lines
boolean | null

List a contact the clinic talks to on several WhatsApp lines once, as its most recently active line's conversation; lines on each row lists all of them. Ignored when channel_ids narrows the list to given lines.

Yanıt

Array of ConversationResource

data
ConversationResource · object[]
gerekli