---
title: "Get a sequence"
method: GET
path: "/sequences/{sequence_id}"
---

# Get a sequence

`GET /sequences/{sequence_id}`

## Path parameters

- `sequence_id` string, required

## Response `200`

Default Response

- GetSequenceOutput
  - `id` string, required
  - `name` string, required
  - `org_id` string, required
  - `custom_id` string, nullable, required
  - `filter` object, nullable, required
    - `or` object[], required
      - `and` ContactsFilter[], required
        - union
          - object
            - `type` 'all_contacts', required
          - object
            - `type` 'contact_id_in', required
            - `contact_ids` string[], required
          - object
            - `type` 'contacts_created_at_between', required
            - `after` string, date-time
            - `before` string, date-time
          - object
            - `type` 'contacts_email_domain_name_in', required
            - `domain_name_in` string[], required
          - object
            - `type` 'contacts_affected_by_sequence', required
            - `sequence_id` string, required
          - object
            - `type` 'contacts_name_in', required
            - `name_in` string[], required
          - object
            - `type` 'contacts_phone_number_in', required
            - `phone_number_in` string[], required
          - object
            - `type` 'contacts_email_in', required
            - `email_in` string[], required
          - object
            - `type` 'contacts_attributes_in', required
            - `attributes` object[]
              - …
          - object
            - `type` 'contacts_sessions_attributes_in', required
            - `attributes` object[]
              - …
          - object
            - `type` 'contact_belongs_to_segment', required
            - `segment_id` string, required
            - `belongs` boolean
          - object
            - `type` 'last_contacted_at_between', required
            - `after` string, date-time
            - `before` string, date-time
          - object
            - `type` 'last_contacted_at_with_handoff_between', required
            - `after` string, date-time
            - `before` string, date-time
          - object
            - `type` 'contact_has_phone', required
            - `has` boolean, required
          - object
            - `type` 'contact_has_email', required
            - `has` boolean, required
          - object
            - `type` 'contact_is_blocked', required
            - `blocked` boolean, required
          - object
            - `type` 'contact_is_unsubscribed', required
            - `unsubscribed` boolean, required
          - object
            - `type` 'contacts_custom_data', required
            - `conditions` object[], required
              - …
  - `steps` SequenceStep[], required
    - `action` union, required
      - object
        - `type` 'send_emails', required
        - `data` object, required
          - `from_email` string, required
          - `email_subject` string, required
          - `email_body` string, required
          - `email_sender_name` string, required
          - `email_is_transactional` boolean, required
      - object
        - `type` 'make_phone_calls', required
        - `data` object, required
          - `aiPhoneAgentId` string, required
      - object
        - `type` 'send_sms_messages', required
        - `data` object, required
          - `message` string, required
      - object
        - `type` 'send_whatsapp_messages', required
        - `data` object, required
          - `phone_number_id` string, required
          - `template` object, required
            - `name` string, required
            - `language` string, required
            - `parameters` WhatsAppTemplateMappingDto, required
              - …
    - `delay_in_minutes` number
    - `started_at` string, date-time
    - `ended_at` string, date-time
  - `is_continuous` boolean, required
  - `started_at` string, date-time, nullable, required
  - `canceled_at` string, date-time, nullable, required
  - `ended_at` string, date-time, nullable, required
  - `status` 'pending' | 'complete' | 'canceled' | 'active', required

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.net/open/apis/opencx-api.md) · [All operations](https://skmtc.net/open/apis/opencx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open/opencx-api/versions/57b06b52302d/schema)