GET
/
v4
/
forms
/
{form_id}
/
subscribers
List subscribers for a form
curl --request GET \
  --url https://api.kit.com/v4/forms/{form_id}/subscribers \
  --header 'X-Kit-Api-Key: <api-key>'
{
  "subscribers": [
    {
      "id": 16006,
      "first_name": null,
      "email_address": "[email protected]",
      "state": "active",
      "created_at": "2023-02-17T11:43:55Z",
      "added_at": "2023-02-17T11:43:55Z",
      "fields": {
        "category": "One"
      },
      "referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
      "referrer_utm_parameters": {
        "source": "facebook",
        "medium": "cpc",
        "campaign": "black_friday",
        "term": "car_owners",
        "content": "get_10_off"
      }
    },
    {
      "id": 16005,
      "first_name": null,
      "email_address": "[email protected]",
      "state": "active",
      "created_at": "2023-02-17T11:43:55Z",
      "added_at": "2023-02-17T11:43:55Z",
      "fields": {
        "category": null
      },
      "referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
      "referrer_utm_parameters": {
        "source": "facebook",
        "medium": "cpc",
        "campaign": "black_friday",
        "term": "car_owners",
        "content": "get_10_off"
      }
    },
    {
      "id": 16004,
      "first_name": null,
      "email_address": "[email protected]",
      "state": "active",
      "created_at": "2023-02-17T11:43:55Z",
      "added_at": "2023-02-17T11:43:55Z",
      "fields": {
        "category": null
      },
      "referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
      "referrer_utm_parameters": {
        "source": "facebook",
        "medium": "cpc",
        "campaign": "black_friday",
        "term": "car_owners",
        "content": "get_10_off"
      }
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzE2MDA2XQ==",
    "end_cursor": "WzE2MDA0XQ==",
    "per_page": 500
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Path Parameters

​
form_id
integer
required

Query Parameters

​
added_after
any

Filter subscribers who have been added to the form after this date (format yyyy-mm-dd)

​
added_before
any

Filter subscribers who have been added to the form before this date (format yyyy-mm-dd)

​
after
any

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

​
before
any

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

​
created_after
any

Filter subscribers who have been created after this date (format yyyy-mm-dd)

​
created_before
any

Filter subscribers who have been created before this date (format yyyy-mm-dd)

​
include_total_count
boolean

To include the total count of records in the response, use true. For large collections, expect a slightly slower response.

​
per_page
any

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

​
status
enum<string>

Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.

Available options:
active,
inactive,
bounced,
complained,
cancelled,
all

Response

200
application/json

Returns a paginated list of subscribers for the specified form

The response is of type object.