Intercom API (unofficial showcase)
GET/audiences

List audiences

Lists audiences configured for the workspace, with pagination metadata. Use page and per_page to paginate the results, and note that per_page is capped at 50.

3 parameters
pageintegeroptional
The page of results to retrieve. Defaults to the first page when omitted.
per_pageintegeroptional
The number of results per page. Defaults to 50 when omitted and must not exceed 50.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a paginated list of audience objects with the total count, current page, page size, and total number of pages.
typestringoptional
The type of the object.
Allowed:list
dataarray<Audience>optional
A list of audience objects.
total_countintegeroptional
The total number of audiences.
pageintegeroptional
The current page number.
per_pageintegeroptional
The number of results per page.
total_pagesintegeroptional
The total number of pages.
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 401 is returned when the request is unauthorized. per_page must not exceed 50; page selects the page to retrieve.