Get Sequence
convertkit.get_sequence
ActionEmailconnection required
Calls the ConvertKit API with the connection's credentials.
Fetch one sequence by its Kit id, with its schedule and email count.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ConvertKit
- Secret shape
- the v4 API key, or {"api_key": "…"}, or {"access_token": "…"} for OAuth
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
sequence_id The Kit id of the sequence. | string | Yes | — | — | 307 |
include Set to 'stats' to have Kit attach open, click and bounce figures. | string | No | — | one of "stats" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"sequence_id": "307"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
sequence The sequence record Kit returned, unchanged. | object | — |
id The sequence's Kit id. | number | — |
name The sequence's name. | string | — |
active True when the sequence is sending. | boolean | — |
{
"active": false,
"id": 0,
"name": "",
"sequence": {}
}See Get Sequence run in a workflow.
In a technical demo we add the ConvertKit connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.