> ## 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.

# What one person will get at one step, rendered

> What one person will get at one step, rendered — Rendered by the same code the send path runs: the step's template filled in for this person, their personalization if they have…



## OpenAPI

````yaml get /sequences/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/preview
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/{sequenceId}/contacts/{contactId}/steps/{stepIndex}/preview:
    get:
      summary: What one person will get at one step, rendered
      description: >-
        Rendered by the same code the send path runs: the step's template filled
        in for this person, their personalization if they have one, or — once
        the step went out — the send record of what they actually received. A
        blocked render names the reason the person would park (missing data, an
        unsendable value, an unreadable template).
      operationId: previewSequenceStepForContact
      parameters:
        - schema:
            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)$
          in: path
          name: sequenceId
          required: true
          description: The unique identifier of the sequence
        - schema:
            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)$
          in: path
          name: contactId
          required: true
          description: The person's contact id (from enroll results or the people list)
        - schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
          in: path
          name: stepIndex
          required: true
          description: Zero-based position in the step list
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SequenceStepPreviewDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    SequenceStepPreviewDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SequenceStepPreviewDto'
      type: object
      properties:
        step_index:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        channel:
          type: string
          enum:
            - whatsapp
            - voice
            - email
        source:
          type: string
          enum:
            - template
            - personalized
            - sent
        stale_personalization:
          type: boolean
        sender_id:
          type:
            - string
            - 'null'
        editable:
          type: boolean
        journey:
          type: object
          properties:
            step_index:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            channel:
              type: string
            state:
              type: string
              enum:
                - not_reached
                - waiting
                - parked
                - deferred
                - skipped
                - sent
                - delivered
                - read
                - replied
                - answered
                - no_answer
                - busy
                - failed
            at:
              anyOf:
                - type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                - type: 'null'
            session_id:
              type:
                - string
                - 'null'
            session_ticket_number:
              anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: 'null'
            reason:
              description: >-
                Why, when the ledger carried a reason: e.g. a skip's
                no_address_for_channel, suppressed, or channel_restricted (the
                contact restricted this step's channel).
              type: string
            number_pool:
              description: >-
                Progress within a phone step using a number pool. Absent for
                other steps; state remains the compatible overall step status.
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - calling
                    - retry_scheduled
                    - answered
                    - exhausted
                    - paused
                    - stopped
                attempts:
                  type: integer
                  minimum: 1
                  maximum: 3
                  description: Number of call attempts started for this step.
                max_attempts:
                  type: integer
                  minimum: 1
                  maximum: 3
                caller_number:
                  description: >-
                    Caller number selected for the latest pool attempt. While
                    waiting to retry, this remains the previous attempt’s number
                    until the next attempt starts.
                  type: string
                next_retry_at:
                  anyOf:
                    - type: string
                      format: date-time
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    - type: 'null'
                  description: >-
                    Earliest time the next attempt can start; null when no retry
                    is scheduled.
              required:
                - status
                - attempts
                - max_attempts
                - next_retry_at
              additionalProperties: false
          required:
            - step_index
            - channel
            - state
            - at
            - session_id
            - session_ticket_number
          additionalProperties: false
        render:
          oneOf:
            - type: object
              properties:
                status:
                  type: string
                  const: rendered
                content:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: email
                        subject:
                          type: string
                        html:
                          type: string
                        text:
                          type: string
                        variables:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: object
                            properties:
                              value:
                                type: string
                              via:
                                type: string
                                enum:
                                  - data
                                  - fallback
                            required:
                              - value
                              - via
                            additionalProperties: false
                          description: >-
                            Each substituted variable with its value and whether
                            it came from the person's data or the binding's
                            fallback. Empty when there is nothing to attribute:
                            a personalization (a hand-written snapshot) or a
                            send record (what went out, whole).
                      required:
                        - type
                        - subject
                        - html
                        - text
                        - variables
                      additionalProperties: false
                    - type: object
                      properties:
                        type:
                          type: string
                          const: voice_call
                        extra_instructions:
                          type:
                            - string
                            - 'null'
                        variables:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: object
                            properties:
                              value:
                                type: string
                              via:
                                type: string
                                enum:
                                  - data
                                  - fallback
                            required:
                              - value
                              - via
                            additionalProperties: false
                          description: >-
                            Each substituted variable with its value and whether
                            it came from the person's data or the binding's
                            fallback. Empty when there is nothing to attribute:
                            a personalization (a hand-written snapshot) or a
                            send record (what went out, whole).
                      required:
                        - type
                        - extra_instructions
                        - variables
                      additionalProperties: false
                    - type: object
                      properties:
                        type:
                          type: string
                          const: whatsapp_template
                        template_name:
                          type: string
                        template_language:
                          type: string
                        values:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: string
                        via:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: string
                            enum:
                              - data
                              - fallback
                        rendered_text:
                          type:
                            - string
                            - 'null'
                      required:
                        - type
                        - template_name
                        - template_language
                        - values
                        - via
                        - rendered_text
                      additionalProperties: false
              required:
                - status
                - content
              additionalProperties: false
            - type: object
              properties:
                status:
                  type: string
                  const: needs_data
                missing:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: string
              required:
                - status
                - missing
              additionalProperties: false
            - type: object
              properties:
                status:
                  type: string
                  const: unsendable_person
                invalid:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: string
              required:
                - status
                - invalid
              additionalProperties: false
            - type: object
              properties:
                status:
                  type: string
                  const: too_long
                length:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                max:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
              required:
                - status
                - length
                - max
              additionalProperties: false
            - type: object
              properties:
                status:
                  type: string
                  const: template_unavailable
                detail:
                  type: string
              required:
                - status
                - detail
              additionalProperties: false
            - type: object
              properties:
                status:
                  type: string
                  const: send_record_unreadable
              required:
                - status
              additionalProperties: false
      required:
        - step_index
        - channel
        - source
        - stale_personalization
        - sender_id
        - editable
        - journey
        - render
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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