Get an audience
GET
/v1/audiences/{audience_id}
curl -X GET "https://us1.platform.bird.com/v1/audiences/{audience_id}" \
-H "Authorization: Bearer $TOKEN"Returns a single audience: its name, description, and type. The member list is separate; fetch it with List an audience's contacts.
Paramètres
audience_id
string
ID of the audience to fetch (adn_-prefixed).
Contenu de la réponse
id
string
obligatoire
ID of the audience (adn_-prefixed), accepted by every operation that takes an audience_id.
name
string
obligatoire
Display name for the audience.
description
nullable string
Longer description of who this audience is.
type
string
obligatoire
How the audience's recipients are determined. static (the default) is an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable; creating an audience with either returns a validation error.
Possible values: static, dynamic, external
created_at
string
obligatoire
updated_at
string
obligatoire