Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kit Subscribers API

The Subscribers API from Kit — 7 operation(s) for subscribers.

Kit Subscribers API is one of 14 APIs that Kit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscribers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 9 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 4.0.

Requests are made against a single base URL, https://api.kit.com.

9 operations 7 paths 6 schemas 4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.0
Base URL
https://api.kit.com/v4
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Kit Subscribers API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Kit-Api-Key (API Key). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 scopes.

  • API Key — Authenticate API requests via an API Key
  • OAuth2 — Authenticate API requests via an OAuth token

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscribers 9
POST
/v4/bulk/subscribers
Bulk create subscribers
body → 200202401403413422
GET
/v4/subscribers
List subscribers
14 params → 200401422
POST
/v4/subscribers
Create a subscriber
body → 200201202401422
POST
/v4/subscribers/filter
Filter subscribers based on engagement
body → 200401
GET
/v4/subscribers/{id}
Get a subscriber
1 param → 200401404
PUT
/v4/subscribers/{id}
Update a subscriber
1 param body → 200202401404422
POST
/v4/subscribers/{id}/unsubscribe
Unsubscribe subscriber
1 param body → 204401404
GET
/v4/subscribers/{subscriber_id}/stats
List stats for a subscriber
3 params → 200401
GET
/v4/subscribers/{subscriber_id}/tags
List tags for a subscriber
5 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are FilterCondition (9 properties), UrlAnyCondition (4 properties), BroadcastAnyCondition (2 properties), IdsAnyCondition (2 properties). Each schema is shown below with its type and property counts.

SubscriberFilterRequest
object
Filter subscribers based on engagement and subscription criteria using the 'all' array with filter conditions that must all be met (AND logic).
2 properties 1 required
FilterCondition
object
A filter condition with type and optional parameters. Used within the 'all' array for complex filtering where multiple conditions must be met.
9 properties 1 required
UrlAnyCondition
object
Filter by URL patterns. Only applicable for 'clicks' type. Subscriber must have clicked ANY of the specified URLs.
4 properties 1 required
FormsAnyCondition
object
Attribution sub-condition: matches subscribers whose original signup attribution points at one of the given form / landing-page ids. Ids may refer to either a…
2 properties 2 required
IdsAnyCondition
object
Match a list of ids. Used by the 'tags' filter to select tag ids.
2 properties 2 required
BroadcastAnyCondition
object
Filter by specific broadcast IDs. Subscriber must have interacted with ANY of the specified broadcasts.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convertkit-subscribers-api-openapi.yml Raw ↑

Other APIs Kit publishes across the network.

Kit Accounts API
Kit Broadcasts API
Kit Custom Fields API
Kit Email Templates API
Kit Forms API
Kit Posts API
Kit Purchases API
Kit Segments API
Kit Sequence Emails API
Kit Sequences API
Kit Snippets API
Kit Tags API