List Conversations

POST

Body

Arguments

string

Conversation scope filter. Supported values include archived, open, unassigned, or all.

string

filter with archived, open, unassigned, or all will show only Archived, Open, Unassigned or All conversations, respectively.

string

filter with archived, open, unassigned, or all will show only Archived, Open, Unassigned or All conversations, respectively.

string

filter with archived, open, unassigned, or all will show only Archived, Open, Unassigned or All conversations, respectively.

string

filter with archived, open, unassigned, or all will show only Archived, Open, Unassigned or All conversations, respectively.

string

Return only conversations relevant to the given user email.

string

for with a value matching a known user email will return only conversations relevant to that user. For example, for a customer user, this would be conversations visible to that customer.

string

Return only conversations relevant to the given customer SSO ID.

string

for_id with a value matching a known user id (from SSO) will return only conversations relevant to that customer user.

string

Supported values include updated or changed.

date

sort with a value of updated will return conversations in descending order of last customer update. A value of changed will return conversations in descending order of any update or status change. The default sort order is by conversation create_at.

string

Comma-separated conversation tags to match.

string

Return only conversations from the given channel slug.

string

data with a hash of key/value pairs (e.g. data[key]=value) will return conversations with data matching those key/value pairs.

date

Filter by latest customer message on or after this ISO 8601 date-time.

date

Filter by latest customer message on or before this ISO 8601 date-time.

string

Filter by conversation origin, for example email, chat, api, instagram, sms, voice, custom, staff, or form.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Every app you connect,one REST pattern