Skip to content
Home/
/Audiences

List all audiences

Request

You can fetch a list of all audiences for the workspace.

Security
bearerAuth
Query
pageinteger

The page of results to fetch. Defaults to first page.

Example:page=1
per_pageinteger, <= 50

The number of results to return per page. Defaults to 50. Maximum is 50.

Example:per_page=50
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.16"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.16
curl -i -X GET \
  'https://api.intercom.io/audiences?page=1&per_page=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.16'

Responses

Successful response

Bodyapplication/json
typestring

The type of the object.

Value:"list"
Example:"list"
dataArray of objects(Audience)

A list of audience objects.

total_countinteger

The total number of audiences.

Example:2
pageinteger

The current page number.

Example:1
per_pageinteger

The number of results per page.

Example:50
total_pagesinteger

The total number of pages.

Example:1
Response
{
  "type": "list",
  "data": [
    { … },
    { … }
  ],
  "total_count": 2,
  "page": 1,
  "per_page": 50,
  "total_pages": 1
}