Intercom API (unofficial showcase)
GET/contacts/deleted

List deleted contacts

Lists contacts in the workspace that are no longer active, including their status and identifiers that can help you locate them for recovery or deletion. Use page and per_page to paginate the results.

3 parameters
per_pageintegeroptional
Number of results per page. Must be between 1 and 150. Defaults to 10 when omitted.
Default:10
pageintegeroptional
Page number to retrieve. Must be at least 1. Defaults to 1 when omitted.
Default:1
Intercom-Versionstringoptional
The Intercom API version to use; the listed values include 1.0 through 2.6. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a paginated list of inactive contacts with their status, identifiers, total count, and pagination metadata.
typestringoptional
Always list
Allowed:list
dataarray<DeletedContact>optional
The list of deleted contact objects.
total_countintegeroptional
A count of the total number of deleted contacts.
pagesobjectoptional
Offset-based pagination metadata.
400Returned when `page` or `per_page` is outside its allowed range.

One documented failure

  • invalid_page

    page must be a positive integer

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

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 per_page or page is outside its allowed range, and a 401 is returned when the request is unauthorized. per_page must be between 1 and 150, and page must be at least 1. The Intercom-Version header defaults to 2.17 when omitted.