Sequences

Get a sequence

Fetches a single sequence by id. Use this when you need the current schedule, the active / repeat / hold flags, the configured email_address and email_template_id, or exclude_subscriber_sources for a known sequence — for example, to confirm settings before adding subscribers or to render an editor.

For the individual emails inside the sequence, use List sequence emails. For the sequence model and field semantics, see Create a sequence.

get/v4/sequences/{id}

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/sequences/{id}
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Path parameters

idinteger required

Query parameters

includestring

Comma-separated list of additional data to include on each sequence. Valid options: stats. stats adds a stats object with deliverability counts and rates (opens, clicks, bounces, complaints, unsubscribes) plus the unsubscriber count, matching the numbers shown on the sequences dashboard.

Response

Returns the sequence details

Changes

No recorded changes to this operation across all 2 revisions of this API.