Skip to main content
GET
/
v4
/
broadcasts
List broadcasts
curl --request GET \
  --url https://api.kit.com/v4/broadcasts \
  --header 'X-Kit-Api-Key: <api-key>'
{
  "broadcasts": [
    {
      "id": 3,
      "publication_id": 3,
      "created_at": "2023-02-17T11:43:55Z",
      "subject": "Campaign subject 3",
      "preview_text": null,
      "description": null,
      "content": null,
      "public": false,
      "published_at": null,
      "send_at": null,
      "thumbnail_alt": null,
      "thumbnail_url": null,
      "public_url": null,
      "email_address": "greetings@kit.dev",
      "email_template": {
        "id": 6,
        "name": "Text Only"
      },
      "subscriber_filter": [
        {
          "all": [
            {
              "type": "all_subscribers"
            }
          ]
        }
      ]
    },
    {
      "id": 2,
      "publication_id": 2,
      "created_at": "2023-02-17T11:43:55Z",
      "subject": "Campaign subject 2",
      "preview_text": null,
      "description": null,
      "content": null,
      "public": false,
      "published_at": null,
      "send_at": null,
      "thumbnail_alt": null,
      "thumbnail_url": null,
      "public_url": null,
      "email_address": "greetings@kit.dev",
      "email_template": {
        "id": 6,
        "name": "Text Only"
      },
      "subscriber_filter": [
        {
          "all": [
            {
              "type": "all_subscribers"
            }
          ]
        }
      ]
    },
    {
      "id": 1,
      "publication_id": 1,
      "created_at": "2023-02-17T11:43:55Z",
      "subject": "Campaign subject 1",
      "preview_text": null,
      "description": null,
      "content": null,
      "public": false,
      "published_at": null,
      "send_at": null,
      "thumbnail_alt": null,
      "thumbnail_url": null,
      "public_url": null,
      "email_address": "greetings@kit.dev",
      "email_template": {
        "id": 6,
        "name": "Text Only"
      },
      "subscriber_filter": [
        {
          "all": [
            {
              "type": "all_subscribers"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzNd",
    "end_cursor": "WzFd",
    "per_page": 500
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.kit.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Query Parameters

​
after
any | null

To fetch next page of results, use ?after=<end_cursor>

​
before
any | null

To fetch previous page of results, use ?before=<start_cursor>

​
include_total_count
boolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

​
per_page
any | null

Number of results per page. Default 500, maximum 1000.

​
sent_after
any | null

Get broadcasts sent after this date (format yyyy-mm-dd).

​
sent_before
any | null

Get broadcasts sent before this date (format yyyy-mm-dd).

Response

Returns a paginated list of all broadcasts for your account (including draft, scheduled, and already sent)

​
broadcasts
object[]
required
​
pagination
object
required