Audiences

Get audience

Returns the editable audience definition for the supplied audience_id, including its name, enabled state, tags, and the campaign components that reference it. For the rendered (runtime) snapshot use GET /v1/audiences/{audience_id}/built instead.

get/v1/audiences/{audience_id}

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/:audience_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

audience_idstring required

Response

Audience definition.

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.