Getting started
Guides
Endpoints
- Accounts
- Broadcasts
- Custom Fields
- Forms
- Subscribers
- Tags
- Email Templates
- Purchases
- Segments
- Sequences
- Webhooks
Forms
List subscribers for a form
GET
/
v4
/
forms
/
{form_id}
/
subscribers
Copy
Ask AI
curl --request GET \
--url https://api.kit.com/v4/forms/{form_id}/subscribers \
--header 'X-Kit-Api-Key: <api-key>'
Copy
Ask AI
{
"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
Authenticate API requests via an API Key
Path Parameters
Query Parameters
Response
200
application/json
Returns a paginated list of subscribers for the specified form
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url https://api.kit.com/v4/forms/{form_id}/subscribers \
--header 'X-Kit-Api-Key: <api-key>'
Copy
Ask AI
{
"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
}
}
Assistant
Responses are generated using AI and may contain mistakes.