List audiences

List audiences with optional filtering by type, segmentation type, status, or name search. Scoped to one project: name it with project_id or the X-Project-Id header.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter by audience type: intents, contact, list, or pixel. elixir is the former name for contact and is still accepted here; either value returns every contact audience, including ones created before the rename.

Allowed:
uuid

Project ID (UUID). Every audience operation except GET /api/v1/audiences/schema is scoped to a project: send this parameter or the X-Project-Id header. Without either the request returns 400 with project_id is required.

uuid

Filter by organization ID (UUID). Ignored for API key callers: the organization is always the key's.

string
enum

Filter by segmentation type: Persona, Account, or Audience.

Allowed:
string
enum

Filter by status.

Allowed:
string

Search by audience name (case-insensitive partial match).

string
enum

Sort by field: name, status, created_at, updated_at, size, or last_downloaded_at.

An unrecognized field is refused with 400 rather than ignored, so a misspelling is answered instead of silently returning the default order.

Allowed:
string
enum

Sort order: asc or desc. Ascending when sort_by is given without it.

Requires sort_by. Sent on its own it is refused with 400, because the ordering used when no field is named is not a single column that a direction could be applied to: unpaused audiences come first, then most recently updated. Omit both to get that ordering.

Deliberately has no default for that reason. A client that filled one in would send it alone on an unsorted request and be refused.

Allowed:
integer
Defaults to 1

Page number (default 1).

integer
≤ 100
Defaults to 20

Page size (default 20, maximum 100).

Headers
uuid

Project ID (UUID). Equivalent to the project_id query parameter; send one or the other.

Responses

401

Missing or invalid authentication.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json