Sign inGet Started

Get audience membership

GET
/v1/audiences/{audience_id}/membership
const result = await bird.audiences.membership(
  "adn_01krdgeqcxet5s7t44vh8rt9mg",
);
if (result.membership) {
  console.log(result.membership.total, result.membership.data_as_of);
}
响应200
{
  "membership": {
    "total": 1284,
    "data_as_of": "2026-10-12T09:41:07.512843Z"
  }
}

Returns the exact number of audience members at the source evaluation instant, including contacts without email and unsubscribed contacts. Membership is absent when the count is unavailable; an empty audience has total zero. For daily observations, use Get audience membership statistics.

Returns 421 when the workspace's organization is served from a different region from the API host. Retry against that workspace's regional host.

参数

audience_idstring

ID of the audience whose membership to read.

响应载荷

membership
object

Exact count of all audience members at the source evaluation instant, including contacts without email and unsubscribed contacts.

显示子属性
membership.total
integer
必填

Number of members at evaluation time.

membership.data_as_of
string
必填

Source evaluation instant for the live count. Membership changes committed after the read began appear in a later response.