conversations

List conversations

Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.

get/3.0/conversations

Request

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

has_unread_messages'true' | 'false'

Whether the conversation has any unread messages.

list_idstring

The unique id for the list.

campaign_idstring

The unique id for the campaign.

Response

total_itemsinteger

The total number of items matching the query regardless of pagination.

Changes

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