Skip to content
DashboardGet API key

List broadcast contacts

View .md
GET

List contacts in a broadcast with optional status filter.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • broadcastIdstringrequired

Query parameters

  • statusstring

    Status of a contact within a broadcast.

    • pending, queued, sending: not handed to the provider yet.
    • sent: accepted by the provider; delivery is not confirmed yet. Channels that never report delivery leave the recipient here.
    • delivered: the channel confirmed delivery to the device. A WhatsApp read receipt also counts as delivered.
    • failed: not delivered. A recipient can move from sent or delivered to failed when the provider reports a failure late.
    • skipped: not sent, because the recipient opted out of the channel or the broadcast was cancelled before reaching it.
    One ofpendingqueuedsendingsentdeliveredfailedskipped
  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

Responses

200List of broadcast contacts.
  • itemsobject[]required
    13 properties
    • idstringrequired
    • recipientstringrequired
    • recipientTypestringrequired
      One ofphoneemail
    • statusstringrequired

      Status of a contact within a broadcast.

      • pending, queued, sending: not handed to the provider yet.
      • sent: accepted by the provider; delivery is not confirmed yet. Channels that never report delivery leave the recipient here.
      • delivered: the channel confirmed delivery to the device. A WhatsApp read receipt also counts as delivered.
      • failed: not delivered. A recipient can move from sent or delivered to failed when the provider reports a failure late.
      • skipped: not sent, because the recipient opted out of the channel or the broadcast was cancelled before reaching it.
      One ofpendingqueuedsendingsentdeliveredfailedskipped
    • templateVariablesobject
      1 properties
      • {key}string
    • templateButtonVariablesobject
      1 properties
      • {key}string
    • templateHeaderVariablesobject
      1 properties
      • {key}string
    • messageIdstring

      Associated message ID after processing.

    • errorCodestring
    • errorMessagestring
    • costnumbernullable
    • processedAtstring<date-time>
    • createdAtstring<date-time>required
  • nextCursorstringnullable
400Invalid query parameters (`invalid_request`): an unknown `status`, `limit` outside 1-100, or a malformed `cursor`.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Broadcast not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject