Skip to main content
GET
/
public-api
/
broadcasts
Retrieve a paginated list of broadcasts
curl --request GET \
  --url https://agents.nineteen58.co.za/public-api/broadcasts \
  --header 'x-api-key: <api-key>'
{
  "broadcasts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "name": "<string>",
      "test": true
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

agent_id
string<uuid>

Filter broadcasts by agent ID

page
integer
default:1

Page number for pagination

Required range: x >= 1
pageSize
integer
default:10

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved broadcasts

broadcasts
object[]