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

# Get journey

> Get one journey by id — its trigger and the ordered steps people move through. Read-only, for inspecting setup.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/journeys/{journeyId}
openapi: 3.1.0
info:
  title: Boom API
  version: 1.0.0
  description: >-
    Boom's public REST API — one uniform surface over every platform capability.
    CDP: upsert people and custom objects, define object and relationship types,
    link and unlink relationships, and record behavioral events — one record per
    request or up to 1000 per request via the `/batch` endpoints. Segments: read
    (list, read, membership) and full authoring — discover the filterable
    catalog, validate a filter, create and update segments, preview match
    counts, and trigger evaluation. Initiatives: create and configure outreach
    initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel,
    archive), and read collected-data summaries. Participants: enroll people
    into an active initiative, track their status, read conversation
    transcripts, and stop outreach. Journeys: read-only access to always-on
    message flows and their metrics. WhatsApp templates: list your WhatsApp
    numbers and list, read, and create message templates. The same capabilities
    are exposed as MCP tools with identical schemas.
servers:
  - url: https://www.useboom.ai
    description: Production
  - url: https://dev.useboom.ai
    description: Development (sandbox — use a development organization API key)
security:
  - bearerAuth: []
paths:
  /api/v1/journeys/{journeyId}:
    get:
      tags:
        - Journeys
      summary: Get journey
      description: >-
        Get one journey by id — its trigger and the ordered steps people move
        through. Read-only, for inspecting setup.
      operationId: journeys_get
      parameters:
        - name: journeyId
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
            minLength: 1
            description: Journey id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  id:
                    type: string
                    description: Journey id.
                  initiativeId:
                    type: string
                    description: The initiative this journey belongs to.
                  name:
                    type: string
                    description: Journey name (from its initiative).
                  status:
                    type: string
                    enum:
                      - DRAFT
                      - ACTIVE
                      - ARCHIVED
                    description: >-
                      DRAFT (still being configured), ACTIVE (live — people can
                      move through it), or ARCHIVED (no longer running).
                  version:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Version number of the journey's current setup. Each time
                      the steps are edited and re-activated, the version
                      increases.
                  createdAt:
                    type: string
                    description: ISO 8601 timestamp.
                  updatedAt:
                    type: string
                    description: ISO 8601 timestamp.
                  trigger:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - manual
                          - segment
                          - event
                        description: >-
                          How people enter the journey: manual (added by an
                          operator or API call), segment (added when they enter
                          a segment), or event (added when an event is received
                          for them).
                      segment:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Segment name, when type is segment.
                      event:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Event name, when type is event.
                    required:
                      - type
                      - segment
                      - event
                    additionalProperties: false
                  steps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Step id, unique within the journey.
                        type:
                          type: string
                          enum:
                            - entry
                            - message
                            - conversation
                            - wait
                            - branch
                            - split
                            - event
                            - end
                            - step
                          description: >-
                            What the step does: entry (where people start),
                            message (sends a message template), conversation (an
                            AI-led conversation), wait (pauses before
                            continuing), branch (routes down a yes or no path),
                            split (routes across several cases), event (records
                            an event), end (finishes the journey), or step (a
                            step of another kind).
                        title:
                          description: The name the journey author gave this step.
                          type: string
                        description:
                          description: >-
                            Plain-language summary of what the step is
                            configured to do.
                          type: string
                      required:
                        - id
                        - type
                      additionalProperties: false
                    description: >-
                      The steps that make up the journey, in the order a person
                      moves through them.
                required:
                  - id
                  - initiativeId
                  - name
                  - status
                  - version
                  - createdAt
                  - updatedAt
                  - trigger
                  - steps
                additionalProperties: false
        '400':
          description: Validation failed or the request cannot proceed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: The resource does not exist in this organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '409':
          description: >-
            Conflicts with the current state (duplicates, wrong lifecycle
            state).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '422':
          description: The request is well-formed but semantically invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '429':
          description: Rate limit exceeded — retry after `Retry-After`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '503':
          description: Transient error — retry with a narrower request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.'

````