Get Audience
GET /v2/partner/audiences/{id}
Required scopes
partner:audiences:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getAudience |
| Tags | Audience |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Responses
200
OK
object
Session-6 addition per `01-partner-api.md` §3.3.
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | audience |
| team_id * | id | UUID v4. |
| name * | string | |
| source * | source | |
| total_contacts * | integer | |
| expires_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| is_archived * | boolean | |
| archived_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| batch_id * | id | UUID v4. |
| predicate_hash | string | |
| materialized_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
GET https://api.digitalonboarding.com/v2/partner/audiences/{id}
Authorization: Bearer <partner-token>