Skip to main content
GET
/
orgs
/
{org_id}
/
broadcasts
/
{broadcast_id}
/
recipients
/
{recipient_id}
Get Broadcast Recipient
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/recipients/{recipient_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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,
    "ai_replies": 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>",
    "ai_replies_at": "2023-11-07T05:31:56Z"
  }
}

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

recipient_id
string
required

Recipient ID

Response

200 - application/json

Schema for a broadcast recipient

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,
org,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
tiktok_dm,
telegram_bot,
gmail,
slack_bot,
twilio,
telnyx,
email
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