Audiences

List audiences

Returns the client's audience definitions sorted by creation date, newest first. By default archived audiences are excluded; pass include_archived=true to include them. Use limit and offset to page (defaults: limit=1000, offset=0). Each entry is the editable definition - for runtime targeting reads, use GET /v1/audiences/built instead.

get/v1/audiences

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v1/audiences/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

include_archivedboolean

limitinteger

offsetinteger

Response

Successful response

component_idsstring[] required

idstring required

Stable Extole identifier for the audience.

tagsstring[] required

Free-form tags applied to the audience.

Example response

[
  {
    "enabled": "handlebars@buildtime:{{enabled}}",
    "name": "handlebars@buildtime:{{name}}"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.