Broadcasts

List broadcast recipients

Returns recipients for a broadcast with individual delivery status. Filter by status.

Billing: Read (free unless it says otherwise) · Rate limit: 120/min

get/v1/messaging/broadcasts/{broadcastId}/recipients

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/broadcasts/{broadcastId}/recipients
  • Auth: HTTP bearer

Path parameters

broadcastIdstring required

Query parameters

skipinteger
limitinteger
status'pending' | 'sent' | 'delivered' | 'read' | 'failed'

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

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