v1

latestOpenAPI 3.0.02026-07-2484509641.9 KB
Audiences

List Audiences

Retrieves a paginated list of all audiences, with optional filtering and sorting. Use this endpoint to browse audiences or to find an audienceId before operating on rows, columns, or enrichment. Filter by type (CONTACT or COMPANY) and searchText (case-insensitive contains match on audience name). Use sort to order results by name, createdAt, updatedAt, or recordCount; prefix with - for descending order (default: -updatedAt). Use page[number] and page[size] (default 25, max 100) to paginate. Returns 200 with a paginated array of audience resources and navigation links. Returns 400 if filter or sort parameters are invalid.

get/studio/v1/audiences

Query parameters

page[number]integer

Page number for the results.

page[size]integer

Number of records to return per page. Default is 25.

sortstring

Field based on which to sort the results. Use '-' prefix for descending order. Allowed values: name, createdAt, updatedAt, recordCount

filter[type]'B2B' | 'B2C'

Filter audiences by record type. CONTACT for person-level records; COMPANY for account-level records.

filter[searchText]string

Search audiences by name using a case-insensitive contains match.

Response

Success