GET
/
v4
/
subscribers
List 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
string

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

​
before
string

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

​
created_after
string

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

​
created_before
string

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

​
email_address
string
​
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
number

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

​
sort_field
string
​
sort_order
enum<string>
Available options:
asc,
desc
​
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
​
updated_after
string

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

​
updated_before
string

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

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.