Skip to main content
GET
List subscribers for a tag

Authorizations

X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Path Parameters

tag_id
integer
required

Query Parameters

after
any | null

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

before
any | null

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

created_after
string | null

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

created_before
string | null

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

include_total_count
boolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

per_page
any | null

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

slim
boolean

When true, omits expensive optional fields from the response. Produces a faster, smaller response — useful when extra fields are not needed.

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
tagged_after
string | null

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

tagged_before
string | null

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

Response

Returns a paginated list of subscribers for the specified tag

subscribers
object[]
required
pagination
object
required