Documentation
Sign inGet started

Get an audience

GET
/v1/audiences/{audience_id}
const audience = await bird.audiences.get("adn_01krdgeqcxet5s7t44vh8rt9mg");
console.log(audience.name);
Returns a single audience: its name, description, and type. The member list is separate; fetch it with List an audience's contacts.
Parâmetros
audience_id
string
ID of the audience to fetch (adn_-prefixed).
Payload de resposta
id
string
obrigatório
ID of the audience (adn_-prefixed), accepted by every operation that takes an audience_id.
name
string
obrigatório
Display name for the audience.
description
nullable string
Longer description of who this audience is.
type
string
obrigatório
How the audience's recipients are determined. static is an explicit member list you manage by adding and removing contacts.
Possible values: static
created_at
string
obrigatório
updated_at
string
obrigatório