> ## Documentation Index > Fetch the complete documentation index at: https://docs.open.cx/llms.txt > Use this file to discover all available pages before exploring further. > List every outbound sequence in the organization with its live numbers: audience, will send, sent, replied, unreachable and needs-you counts. # List outbound sequences ## OpenAPI ````yaml get /sequences openapi: 3.1.0 info: title: OpenCX API description: > OpenCX is an AI-powered, all-in-one platform for customer support and outbound communications. Use this API to manage your OpenCX organization's AI agents, actions, conversations, contacts, and more. To get started, generate a new API key from the dashboard. ## Authentication All API endpoints require authentication using a Bearer token. You can generate an API key from your OpenCX dashboard. ## Rate Limiting API requests are rate limited to ensure fair usage. The current limits are: - 100 requests per minute for standard endpoints - 1000 requests per minute for streaming endpoints ## Error Handling The API uses standard HTTP status codes and returns detailed error messages in the response body. version: 1.0-beta license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: http://localhost:8080 description: Development - url: https://api.open.cx description: Production security: - bearerAuth: [] paths: /sequences: get: summary: List outbound sequences operationId: listSequences responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/ListSequencesDto' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' components: schemas: ListSequencesDto: $schema: https://json-schema.org/draft/2020-12/schema $id: '#/components/schemas/ListSequencesDto' type: object properties: sequences: type: array items: $ref: '#/components/schemas/SequenceListItemDto' required: - sequences additionalProperties: false ErrorDto: type: object properties: statusCode: type: integer message: type: string error: type: string SequenceListItemDto: $schema: https://json-schema.org/draft/2020-12/schema $id: '#/components/schemas/SequenceListItemDto' type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ org_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string status: type: string enum: - draft - active - paused steps: type: array items: oneOf: - type: object properties: channel: type: string const: whatsapp content: type: object properties: type: type: string const: whatsapp_template template_name: type: string minLength: 1 template_language: type: string minLength: 1 variables: type: object propertyNames: type: string additionalProperties: type: object properties: source: type: string enum: - display_name - phone - email fallback: type: string required: - source additionalProperties: false required: - type - template_name - template_language - variables additionalProperties: false delay_minutes: type: integer minimum: 0 maximum: 129600 required: - channel - content - delay_minutes additionalProperties: false - type: object properties: channel: type: string const: voice content: type: object properties: type: type: string const: voice_call extra_instructions: type: string minLength: 1 maxLength: 8000 variables: type: object propertyNames: type: string minLength: 1 maxLength: 64 additionalProperties: type: object properties: source: type: string enum: - display_name - phone - email fallback: type: string required: - source additionalProperties: false required: - type additionalProperties: false delay_minutes: type: integer minimum: 0 maximum: 129600 required: - channel - content - delay_minutes additionalProperties: false - type: object properties: channel: type: string const: email content: type: object properties: type: type: string const: email subject: type: string minLength: 1 html: type: string minLength: 1 text: type: string minLength: 1 variables: default: {} type: object propertyNames: type: string additionalProperties: type: object properties: source: type: string enum: - display_name - phone - email fallback: type: string required: - source additionalProperties: false required: - type - subject - html - text - variables additionalProperties: false delay_minutes: type: integer minimum: 0 maximum: 129600 required: - channel - content - delay_minutes additionalProperties: false settings: type: object properties: block_active_elsewhere: type: boolean block_contacted_before: type: boolean respect_office_hours: type: boolean office_hours_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ additionalProperties: false brief: type: string reply_instructions: type: string criteria: type: object properties: must: maxItems: 20 type: array items: type: object properties: label: type: string minLength: 2 maxLength: 60 description: >- A few words naming this criterion, shown in the dashboard — "Recent invoicing complaint", "Business account". Not a sentence. text: type: string minLength: 3 maxLength: 500 description: >- The full instruction the judge reads. Name the boundary explicitly — what counts and what does not. Never shown in the table. required: - label - text additionalProperties: false nice: maxItems: 20 type: array items: type: object properties: label: type: string minLength: 2 maxLength: 60 description: >- A few words naming this criterion, shown in the dashboard — "Recent invoicing complaint", "Business account". Not a sentence. text: type: string minLength: 3 maxLength: 500 description: >- The full instruction the judge reads. Name the boundary explicitly — what counts and what does not. Never shown in the table. grade: type: string enum: - high - medium - low required: - label - text - grade additionalProperties: false required: - must - nice additionalProperties: false columns: maxItems: 12 type: array items: type: object properties: key: type: string minLength: 1 maxLength: 59 pattern: ^[a-z0-9_]+$ label: type: string minLength: 1 maxLength: 60 path: type: string minLength: 1 maxLength: 300 type: type: string enum: - string - number - boolean - date - string[] - number[] required: - key - label - path - type additionalProperties: false created_at: type: string format: date-time updated_at: type: string format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' stats: type: object properties: people: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Everyone this sequence is for: enrolled minus the people the judge turned down. Not scoped to a status — someone who replied, finished or opted out was still part of the audience. Always equals will_send + might_send. will_send: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The JUDGED half of `people`, not "everyone here passed": those who cleared the arming floor, plus anyone a later run scored below it after we had already armed or messaged them — a verdict cannot un-send a message. Before launch the two readings coincide, which is the only place this is shown as "will send to"; afterwards read `in_flight` for what can still happen. might_send: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Never judged. These arm too — an unjudged list is user authority. For a sequence that has not launched, the audience it would send to is will_send + might_send; once it has, some of those people are already done and `in_flight` is the forward-looking number. rejected: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Judged and turned down BEFORE anything was sent — the exact complement of `people`, so the two are `enrolled`. Someone already armed when a later run failed them is not here; they stay in the audience. enrolled: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The whole list, judged-down included — people + rejected. has_criteria: type: boolean description: >- Whether there is anything for the judge to work against. Decides whether the audience has a split worth showing at all. sent: type: integer minimum: -9007199254740991 maximum: 9007199254740991 replied: type: integer minimum: -9007199254740991 maximum: 9007199254740991 wont_reach: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Concluded without ever being reached — journey over, nothing sent. Terminal only: parked people and deferrals are excluded, since neither is a conclusion. people = sent + wont_reach + (in flight and never contacted) — someone mid-sequence has been contacted AND is still in flight, so the plain three-term form double counts them. needs_you: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Parked: waiting on a human to fix something, after which the journey resumes where it stopped. Kept apart from wont_reach because it is a call to action, not attrition. A SLICE of the still-in-flight people, not a fourth bucket beside them — someone parked after step 0 is counted here and in `sent`, so do not add this to the others. finished: type: boolean description: >- Nothing left in flight and something already went out. Derived, never stored — the status stays `active`, so enrolling more people revives the sequence on its own. busy: type: boolean description: An enrich or judge run is in flight for this sequence. required: - people - will_send - might_send - rejected - enrolled - has_criteria - sent - replied - wont_reach - needs_you - finished - busy additionalProperties: false required: - id - org_id - name - status - steps - settings - brief - reply_instructions - criteria - columns - created_at - updated_at - deleted_at - stats additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````