email-audiences

Get audience membership

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.

get/v1/audiences/{audience_id}/membership

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/audiences/{audience_id}/membership
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

audience_idstring required
Example:adn_01krdgeqcxet5s7t44vh8rt9mg

ID of the audience whose membership to read.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Exact audience membership, when available.

Changes

No recorded changes to this operation across all 2 revisions of this API.