Skip to main content
POST
/
v4
/
subscribers
/
filter
Filter subscribers based on engagement
curl --request POST \
  --url https://api.kit.com/v4/subscribers/filter \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '
{
  "subscribed": {
    "after": "2024-01-01",
    "before": "2024-12-31"
  },
  "opens": {
    "count_greater_than": 5,
    "count_less_than": 50,
    "after": "2024-06-01",
    "before": "2024-12-01",
    "broadcasts": [
      101,
      102,
      103
    ]
  },
  "clicks": {
    "count_greater_than": 2,
    "count_less_than": 20,
    "after": "2024-07-01",
    "before": "2024-11-30",
    "links": [
      201,
      202
    ],
    "url_ids": [
      301,
      302
    ],
    "urls": [
      "https://example.com/newsletter",
      "https://example.com/blog"
    ],
    "url_matching": "contains"
  },
  "sent": {
    "count_greater_than": 1,
    "count_less_than": 100,
    "after": "2024-05-01",
    "before": "2024-12-31",
    "broadcasts": [
      104,
      105
    ]
  },
  "delivered": {
    "count_greater_than": 1,
    "count_less_than": 95,
    "after": "2024-05-01",
    "before": "2024-12-31",
    "broadcasts": [
      104,
      105,
      106
    ]
  },
  "per_page": 10,
  "after": null,
  "before": null,
  "sort_field": null,
  "sort_order": null,
  "include_total_count": false
}
'
{
  "subscribers": [
    {
      "id": "456",
      "first_name": "Jane",
      "email_address": "[email protected]",
      "created_at": "2024-12-01T15:45:00Z"
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzQ1Nl0=",
    "end_cursor": "WzQ1Nl0=",
    "per_page": 100
  }
}

Authorizations

X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Body

application/json
subscribed
object
opens
object
clicks
object
sent
object
delivered
object
per_page
integer
after
unknown
before
unknown
sort_field
unknown
sort_order
unknown
include_total_count
boolean

Response

Returns a list of subscribers matching the filters

subscribers
object[]
required
pagination
object
required