Intercom API (unofficial showcase)
GET/conversations/deleted

List deleted conversation IDs

Lists IDs and retained metadata for deleted conversations. Use page and per_page to paginate the results; each page contains up to 20 results by default. Set order to asc or desc to control the ordering of conversation IDs.

4 parameters
pageintegeroptional
The page of results to fetch. Defaults to the first page when omitted.
per_pageintegeroptional
The number of results per page. Defaults to 20 when omitted and must not exceed 60.
Default:20
orderstringoptional
The order of conversation IDs: `asc` for ascending or `desc` for descending. Defaults to `desc` when omitted.
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported versions include 1.0–1.4 and 2.0–2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a paginated list of deleted conversation records, including their IDs, metrics-retained status, deletion timestamps, total count, and pagination details.
typestringoptional
String representing the object's type. Always has the value `conversations.list`.
conversationsarray<Conversation>optional
The list of deleted conversation IDs.
total_countintegeroptional
Total number of items available.
pagesobjectoptional
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.
400Returned when the requested resource is unavailable.

One documented failure

  • intercom_version_invalid

    Requested resource is not available in current API version.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthenticated.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the requested resource is unavailable, and a 401 is returned when the request is unauthenticated. per_page must not exceed 60; order accepts asc or desc.