Skip to main content
GET
/
orgs
/
{org_id}
/
broadcasts
Get Broadcasts
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts
[
  {
    "id": "<string>",
    "name": "<string>",
    "status": "DRAFT",
    "scheduled_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "contacts_count": 123,
    "recipients_count": 123,
    "skipped_count": 123,
    "sent_count": 123,
    "failed_count": 123,
    "delivered_count": 123,
    "opened_count": 123,
    "played_count": 123,
    "click_count": 123,
    "complained_count": 123,
    "unsubscribed_count": 123,
    "error_message": "<string>",
    "segments": [
      {
        "id": "<string>",
        "name": "<string>",
        "contacts_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "send_to_all": true,
    "templates": [
      {
        "id": "<string>",
        "broadcast_id": "<string>",
        "connection_id": "<string>",
        "integration_id": "internal",
        "recipients_count": 123,
        "config": {},
        "error": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Path Parameters

org_id
string
required

The ID of the org

Query Parameters

status
enum<string>

The status of the broadcasts

Available options:
ALL,
DRAFT,
SCHEDULED,
SENDING,
SENT,
CANCELLED,
FAILED
Maximum string length: 256
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
name
string
required
status
enum<string>
required

The status of the broadcast

Available options:
DRAFT,
SCHEDULED,
SENDING,
SENT,
CANCELLED,
FAILED
scheduled_at
string<date-time> | null
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
contacts_count
number
required
recipients_count
number
required
skipped_count
number
required
sent_count
number
required
failed_count
number
required
delivered_count
number
required
opened_count
number
required
played_count
number
required
click_count
number
required
complained_count
number
required
unsubscribed_count
number
required
error_message
string | null
required
segments
object[]
required
send_to_all
boolean
required
templates
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required