Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The sequence's prefixed id (e.g. seq_abc123).

Response

The sequence

object
enum<string>
required
Available options:
sequence
id
string
required
name
string
required
status
enum<string>
required
Available options:
draft,
active,
paused
trigger
object
required
exit
object
required
send_days
enum<string>[]
required

Weekdays a step may go out, in the business's time zone. A step due on another day waits for the next allowed day at the same local time.

Available options:
sun,
mon,
tue,
wed,
thu,
fri,
sat
from
string | null
required
reply_to
string | null
required
styled
boolean
required
steps
object[]
required

Live steps in send order.

metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required