> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clarionhealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Sequence

> Returns a specific sequence by ID. Pass `includeMetrics=true` to receive the sequence together with its outreach array (calls and SMS encounters with analysis).

Returns a single sequence by ID. Pass `?includeMetrics=true` to receive the sequence together with its outreach array (calls and SMS encounters with analysis). Without the flag, the response is the sequence record only.


## OpenAPI

````yaml GET /sequence-manager/sequences/{id}
openapi: 3.0.1
info:
  title: Clarion API
  description: >-
    Clarion's public facing API. For more information, please visit
    https://docs.clarionhealth.com
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.clarionhealth.com/v1
security:
  - bearerAuth: []
paths:
  /sequence-manager/sequences/{id}:
    get:
      description: >-
        Returns a specific sequence by ID. Pass `includeMetrics=true` to receive
        the sequence together with its outreach array (calls and SMS encounters
        with analysis).
      parameters:
        - name: id
          in: path
          description: The sequence ID
          required: true
          schema:
            type: integer
        - name: includeMetrics
          in: query
          description: >-
            When true, the response includes the `outreach` array with per-step
            call and SMS metrics.
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Sequence object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sequence'
        '404':
          description: Sequence not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  schemas:
    Sequence:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the sequence
        status:
          type: string
          description: Current status of the sequence
          enum:
            - in-progress
            - completed
            - failed
            - cancelled
            - queued
            - paused
        ended_reason:
          type: string
          nullable: true
          description: Reason why the sequence ended
        ended_reason_v2:
          type: string
          nullable: true
          description: Updated reason why the sequence ended
        current_step:
          type: integer
          description: Current step number in the sequence
        next_activity:
          type: string
          format: date-time
          nullable: true
          description: When the next activity is scheduled
        organization_id:
          type: integer
          description: ID of the organization this sequence belongs to
        patient_id:
          type: integer
          description: ID of the patient this sequence is for
        type:
          type: string
          description: Type of sequence
          enum:
            - appointment_reminder
            - follow_up
            - other
        steps:
          type: array
          items:
            $ref: '#/components/schemas/SequenceStep'
          description: List of steps in the sequence
        sequence_definition_id:
          type: integer
          description: ID of the sequence definition this sequence is based on
        inputs:
          type: array
          items:
            $ref: '#/components/schemas/SequenceInput'
          description: Input values for the sequence
        outcome:
          type: string
          nullable: true
          description: Final outcome of the sequence
        was_contact_reached:
          type: boolean
          description: Whether the contact was successfully reached
        claimed_at:
          type: string
          format: date-time
          nullable: true
          description: When the sequence was claimed
        is_test_mode:
          type: boolean
          description: Whether this sequence is running in test mode
        last_updated:
          type: string
          format: date-time
          description: When the sequence was last updated
    SequenceStep:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the step
        type:
          type: string
          enum:
            - voice
            - email
            - sms
            - task
          description: Type of step
        inputs:
          type: array
          items:
            type: object
          description: Input parameters for this step
        status:
          type: string
          enum:
            - pending
            - in-progress
            - completed
            - failed
            - skipped
          description: Current status of the step
        scheduled_at:
          type: string
          format: date-time
          nullable: true
          description: When this step is scheduled to run
        voicemail_message:
          type: string
          nullable: true
          description: Voicemail message for voice steps
        source_number:
          type: string
          nullable: true
          description: Source phone number for voice steps
        destination_number:
          type: string
          nullable: true
          description: Destination phone number for voice steps
        voice_assistant_id:
          type: integer
          nullable: true
          description: ID of the voice assistant for voice steps
        post_actions:
          type: array
          items:
            type: object
          description: Actions to perform after this step completes
    SequenceInput:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the input
        value:
          type: string
          description: The input value
        name:
          type: string
          description: Display name for the input
        type:
          type: string
          enum:
            - text
            - number
            - date
            - boolean
          description: Type of the input value
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.