List broadcasts
Authorization
Bearer AuthorizationBearer <token>
API key (rlay_live_* or rlay_test_*)
In: header
Query Parameters
workspace_id?string
Filter by workspace ID
account_id?string
Filter by account ID
status?string
Filter by status
Value in
"draft" | "scheduled" | "sending" | "sent" | "partially_failed" | "failed" | "cancelled"cursor?string
Pagination cursor
limit?integer
Number of items per page
Default
20Range
1 <= value <= 100Response Body
application/json
curl -X GET "https://api.relayapi.dev/v1/broadcasts"{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"platform": "string",
"account_id": "string",
"status": "draft",
"message_text": "string",
"template_name": "string",
"template_language": "string",
"recipient_count": 0,
"sent_count": 0,
"failed_count": 0,
"scheduled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string",
"has_more": true
}Found something wrong? Help us improve this page.