Sign in
latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

List all broadcasts

Retrieves a paginated list of broadcasts for the project. Returns basic information about each broadcast including its creation time and status.

get/broadcasts

Query parameters

limitinteger

defines the maximum number of items to return per page (default: 50)

starting_afterstring

a cursor for use in pagination, points to the last ID in previous page

ending_beforestring

a cursor for use in pagination, points to the first ID in next page

Response

OK

Example response

{
  "data": [
    {
      "action_url": "https://example.com",
      "category": "example",
      "content": "I come from broadcast",
      "custom_attributes": {},
      "id": "d1b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
      "overrides": {},
      "recipients": [
        {
          "custom_attributes": {
            "plan": "enterprise",
            "preferred_pronoun": "They",
            "pricing_version": "v10"
          },
          "email": "test@example.com",
          "external_id": "83d987a-83fd034",
          "first_name": "Person",
          "last_name": "Doe",
          "phone_numbers": [
            "+1 5005550001"
          ]
        }
      ],
      "title": "Hello, World!",
      "topic": "example"
    }
  ],
  "links": {
    "first": "https://api.magicbell.com/v1/example",
    "next": "https://api.magicbell.com/v1/example?page_next=abc",
    "prev": null
  }
}