Skip to main content
GET
/
sequences
/
{sequence_id}
Get a sequence
curl --request GET \
  --url https://api.open.cx/sequences/{sequence_id}
{
  "id": "<string>",
  "name": "<string>",
  "org_id": "<string>",
  "custom_id": "<string>",
  "filter": {
    "or": [
      {
        "and": [
          {
            "type": "<string>"
          }
        ]
      }
    ]
  },
  "steps": [
    {
      "action": {
        "type": "<string>",
        "data": {
          "from_email": "<string>",
          "email_subject": "<string>",
          "email_body": "<string>",
          "email_sender_name": "<string>",
          "email_is_transactional": true
        }
      },
      "delay_in_minutes": 1,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z"
    }
  ],
  "is_continuous": true,
  "started_at": "2023-11-07T05:31:56Z",
  "canceled_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "status": "pending"
}

Path Parameters

​
sequence_id
string
required

The unique identifier of the sequence

Response

Default Response

​
id
string
required
​
name
string
required
​
org_id
string
required
​
custom_id
string | null
required
Maximum string length: 50
​
filter
object
required
​
steps
object[]
required
​
is_continuous
boolean
required
​
started_at
string<date-time> | null
required
​
canceled_at
string<date-time> | null
required
​
ended_at
string<date-time> | null
required
​
status
enum<string> | null
required
Available options:
pending,
complete,
canceled,
active