Skip to content
Home/
REST API Reference
/
/
Conversations

Conversations

A paginated list of deleted conversation IDs.

typestring

String representing the object's type. Always has the value conversations.list.

Example:"conversations.list"
conversationsArray of objects(Conversation)

The list of deleted conversation IDs.

total_countinteger

Total number of items available.

Example:10
pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

{
  "type": "conversations.list",
  "conversations": [
    { … }
  ],
  "total_count": 10,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  }
}