List subscribers with the Kit API

Lists the subscribers with their id, email, first name, state and custom fields, only the active ones by default. Look one up by email_address. The response has subscribers and pagination; while has_next_page is true, pass pagination.end_cursor as after.

Identifier
kit_list_subscribers

The request

POST https://connect.reportei.com/api/tools/kit_list_subscribers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "email_address": "<email_address>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
email_addressstringNoOnly the subscriber with exactly this email address. Does not work together with an engagement sort_field.
statusstringNoOnly the subscribers in this state. The default is active, and all returns every state.Values: active, inactive, bounced, complained, cancelled, all
created_afterstringNoOnly the subscribers created after this date, as YYYY-MM-DD.
created_beforestringNoOnly the subscribers created before this date, as YYYY-MM-DD.
updated_afterstringNoOnly the subscribers updated after this date, as YYYY-MM-DD.
updated_beforestringNoOnly the subscribers updated before this date, as YYYY-MM-DD.
sort_fieldstringNoField to sort by. The default is id. The engagement fields count the last 90 days, and cancelled_at needs status cancelled.Values: id, created_at, updated_at, cancelled_at, engagement__sent, engagement__opens, engagement__clicks, engagement__open_rate, engagement__click_rate
sort_orderstringNoOrder of the sort.Values: asc, desc
includestringNoExtra fields on each subscriber, separated by commas: attribution, tags, location, and canceled_at, which needs status cancelled.
per_pageintegerNoSubscribers per page, up to 1000. The default is 500.
afterstringNoThe pagination.end_cursor of the previous page.

Supported connections

Your customer connects their Kit account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/kit, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/kit_list_subscribers. It becomes your agent's tool definition with no conversion.

Other Kit tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.