GET
/
v4
/
subscribers
curl --request GET \
  --url https://api.kit.com/v4/subscribers \
  --header 'X-Kit-Api-Key: <api-key>'
{
  "subscribers": [
    {
      "id": 16479,
      "first_name": "Alice",
      "email_address": "[email protected]",
      "state": "active",
      "created_at": "2023-01-27T11:43:55Z",
      "fields": {
        "category": "One"
      }
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzE2NDc5XQ==",
    "end_cursor": "WzE2NDc5XQ==",
    "per_page": 500
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Query Parameters

​
after
any
​
before
any
​
created_after
string
​
created_before
string
​
email_address
string
​
include_total_count
string
​
per_page
any
​
sort_field
string
​
sort_order
string
​
status
string
​
updated_after
string
​
updated_before
string

Response

200
application/json

Returns a list of subscribers matching the sort and filter params, defaulting to active subscribers sorted in descending order by id

The response is of type object.

GET
/
v4
/
subscribers
curl --request GET \
  --url https://api.kit.com/v4/subscribers \
  --header 'X-Kit-Api-Key: <api-key>'
{
  "subscribers": [
    {
      "id": 16479,
      "first_name": "Alice",
      "email_address": "[email protected]",
      "state": "active",
      "created_at": "2023-01-27T11:43:55Z",
      "fields": {
        "category": "One"
      }
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzE2NDc5XQ==",
    "end_cursor": "WzE2NDc5XQ==",
    "per_page": 500
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Query Parameters

​
after
any
​
before
any
​
created_after
string
​
created_before
string
​
email_address
string
​
include_total_count
string
​
per_page
any
​
sort_field
string
​
sort_order
string
​
status
string
​
updated_after
string
​
updated_before
string

Response

200
application/json

Returns a list of subscribers matching the sort and filter params, defaulting to active subscribers sorted in descending order by id

The response is of type object.