Skip to main content
GET
/
orgs
/
{org_id}
/
broadcasts
/
{broadcast_id}
/
recipients
Get Broadcast Recipients
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "broadcast_id": "<string>",
    "broadcast_name": "<string>",
    "template_id": "<string>",
    "user_id": "<string>",
    "name": "<string>",
    "username": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "is_skipped": true,
    "is_skipped_at": "2023-11-07T05:31:56Z",
    "is_failed": true,
    "is_failed_at": "2023-11-07T05:31:56Z",
    "is_bounced": true,
    "is_bounced_at": "2023-11-07T05:31:56Z",
    "is_sent": true,
    "is_sent_at": "2023-11-07T05:31:56Z",
    "is_delivered": true,
    "is_delivered_at": "2023-11-07T05:31:56Z",
    "is_complained": true,
    "is_complained_at": "2023-11-07T05:31:56Z",
    "is_unsubscribed": true,
    "is_unsubscribed_at": "2023-11-07T05:31:56Z",
    "is_opened": true,
    "is_opened_at": "2023-11-07T05:31:56Z",
    "is_played": true,
    "is_played_at": "2023-11-07T05:31:56Z",
    "error_message": "<string>",
    "external_message_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "contact": {
      "id": "<string>",
      "name": "<string>",
      "blocked": true,
      "unsubscribed": true,
      "is_admin": true,
      "channels": [
        {
          "id": "<string>",
          "user_id": "<string>",
          "avatar": "<string>",
          "name": "<string>",
          "username": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "country": "<string>",
          "agent": "<string>",
          "ip": "<string>",
          "language": "<string>",
          "platform_data": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "link": "<string>"
        }
      ],
      "segments": [
        {
          "id": "<string>",
          "name": "<string>",
          "contacts_count": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "properties": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "blocked_at": "2023-11-07T05:31:56Z",
      "unsubscribed_at": "2023-11-07T05:31:56Z",
      "unsubscribe_reason": "<string>",
      "unsubscribe_feedback": "<string>"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
org_id
string
required

Org ID

​
broadcast_id
string
required

Broadcast ID

Query Parameters

​
status
enum<string>

The status of the broadcast recipients

Available options:
ALL,
SENDING,
PROCESSED
​
is_skipped
boolean
​
is_failed
boolean
​
is_bounced
boolean
​
is_sent
boolean
​
is_delivered
boolean
​
is_complained
boolean
​
is_unsubscribed
boolean
​
is_opened
boolean
​
is_played
boolean
​
integration_id
string
​
contact_id
string
​
user_id
string
​
username
string
​
email
string
​
search
string
​
sort_field
enum<string>

Field to sort broadcast recipients by

Available options:
created_at,
updated_at
​
sort_direction
enum<string>

Direction to sort broadcast recipients by

Available options:
asc,
desc
​
page
number

Page number

​
take
number

Number of items to take

​
next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
​
id
string
required
​
broadcast_id
string
required
​
broadcast_name
string
required
​
template_id
string | null
required
​
integration_id
enum<string>
required

ID of the connection integration

Available options:
internal,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
tiktok_dm,
telegram_bot,
gmail,
slack_bot,
twilio,
telnyx,
email,
google_calendar
​
user_id
string | null
required
​
name
string | null
required
​
username
string | null
required
​
phone
string | null
required
​
email
string | null
required
​
status
enum<string>
required

The status of the broadcast recipient

Available options:
SENDING,
PROCESSED
​
source
enum<string> | null
required

How the recipient was triggered (transactional only)

Available options:
API,
MANUAL,
INBOX,
null
​
is_skipped
boolean | null
required
​
is_skipped_at
string<date-time> | null
required
​
is_failed
boolean | null
required
​
is_failed_at
string<date-time> | null
required
​
is_bounced
boolean | null
required
​
is_bounced_at
string<date-time> | null
required
​
is_sent
boolean | null
required
​
is_sent_at
string<date-time> | null
required
​
is_delivered
boolean | null
required
​
is_delivered_at
string<date-time> | null
required
​
is_complained
boolean | null
required
​
is_complained_at
string<date-time> | null
required
​
is_unsubscribed
boolean | null
required
​
is_unsubscribed_at
string<date-time> | null
required
​
is_opened
boolean | null
required
​
is_opened_at
string<date-time> | null
required
​
is_played
boolean | null
required
​
is_played_at
string<date-time> | null
required
​
error_message
string | null
required
​
external_message_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
contact
object

Schema for the contact