Skip to main content
Use this endpoint to fetch the full details of a specific message sequence. Supply the sequence’s unique ID as a path parameter to retrieve its configuration, status, and engagement metrics, including open rate and click-through rate.
GET /api/v1/sequences/{id}

Path Parameters

string
required
The unique ID of the sequence to retrieve.

Code Examples

Response

Returns 200 OK with the full sequence object.

Response Fields

string
required
Unique identifier for the sequence.
string
required
Display name of the sequence.
boolean
required
Whether the sequence is currently active and enrolling new subscribers.
integer
required
Total number of contacts who have ever entered the sequence.
integer
required
Total number of messages delivered across all steps of the sequence.
number | null
required
The message open rate as a decimal (e.g., 0.45 for 45%), or null if there is no data yet.
number | null
required
The click-through rate as a decimal (e.g., 0.12 for 12%), or null if there is no data yet.
string | null
required
The folder this sequence is organised into, or null if not in a folder.
string
required
The ID of the workspace this sequence belongs to.
string
required
ISO 8601 timestamp for when the sequence was created.
string
required
ISO 8601 timestamp for when the sequence was last updated.

Example Response