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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
sequence_id
string
required

ID or custom ID for the sequence

Response

​
id
string
required
​
name
string
required
​
org_id
string
required
​
custom_id
string | null
required
Maximum string length: 50
​
filter
ContactsCompositeFilter · object
required

A combination of contact filters. All filters within and arrays must apply to a contact in order for the contact to be included. On the other hand, only one of the filters within the or array must apply for the contact to be included. If no filter is provided, all contacts will be included.

​
steps
object[]
required
​
is_continuous
boolean
required
​
started_at
string | null
required
​
canceled_at
string | null
required
​
ended_at
string | null
required
​
status
enum<string> | null
required
Available options:
pending,
complete,
canceled,
active