Mail API reference

Mail API · Broadcasts

get/v1/workspaces/{workspace_id}/broadcasts/audienceAuth

Count a broadcast audience

How many contacts a broadcast to this segment and/or topic would reach if it were sent now: members of the segment, subscribed to the topic, minus anyone unsubscribed or on the suppression list.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Query parameters

segment_idstring · uuid

Count the contacts in this segment; omit for every subscribed contact.

topic_idstring · uuid

Leave out contacts who opted out of this topic.

Response · 200

recipients*number

Who a send started now would reach: segment ∩ topic subscribers − unsubscribed − suppressed.

Example: 1180

segment_contacts*number

Everyone in the segment, before the exclusions. Null without a segment.

Example: 1240

computed_at*string · date-time

When the counts were computed.

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/broadcasts/audience
Authorization: Bearer YOUR_TOKEN

Response

{
  "recipients": 1180,
  "segment_contacts": 1240,
  "computed_at": "2026-01-01T00:00:00.000Z"
}