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

# Get campaign reply flow

> Gets one reply flow revision in a project. Beta: returns `403` unless campaign reply flows are enabled for the team.

Requires `campaigns:read`. Project tokens only access resources in their own project.



## OpenAPI

````yaml api-reference/features/campaigns.json GET /platform/campaign-reply-flows/{replyFlowId}
openapi: 3.0.3
info:
  title: Campaigns API methods
  version: 1.0.0
  description: Task-focused campaigns methods across supported Polymorfa connection types.
servers: []
security: []
paths:
  /platform/campaign-reply-flows/{replyFlowId}:
    get:
      tags:
        - Campaigns
      summary: Get campaign reply flow
      description: >-
        Gets one reply flow revision in a project. Beta: returns `403` unless
        campaign reply flows are enabled for the team.


        Requires `campaigns:read`. Project tokens only access resources in their
        own project.
      operationId: managementGetPlatformCampaignReplyFlow
      parameters:
        - name: replyFlowId
          in: path
          required: true
          schema:
            type: string
          description: Identifier for the reply flow.
        - name: projectId
          in: query
          required: false
          schema:
            type: string
          description: Identifier of the Polymorfa project that owns this resource.
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            X-Trace-Id:
              schema:
                type: string
                pattern: ^[0-9a-f]{32}$
              description: >-
                W3C trace ID of this request. Your `traceparent` trace ID when
                you sent a valid one.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    allOf:
                      - $ref: >-
                          #/components/schemas/management__PlatformCampaignReplyFlow
                    description: Structured data carried by this object.
                required:
                  - data
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
        '404':
          $ref: '#/components/responses/management__NotFound'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
components:
  schemas:
    management__PlatformCampaignReplyFlow:
      type: object
      additionalProperties: false
      required:
        - id
        - flowKey
        - revision
        - name
        - definition
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          description: |-
            Identifier for this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        flowKey:
          type: string
          format: uuid
          description: |-
            Groups the revisions of one reply flow.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        revision:
          type: integer
          description: Specifies revision for this management platform campaign reply flow.
        name:
          type: string
          description: Human-readable name for this resource.
        definition:
          allOf:
            - $ref: >-
                #/components/schemas/management__PlatformCampaignReplyFlowDefinition
          description: Structured definition for this resource.
        createdAt:
          type: integer
          description: Unix milliseconds.
    management__PlatformCampaignReplyFlowDefinition:
      type: object
      additionalProperties: false
      required:
        - entryNodeId
        - nodes
      description: >-
        An acyclic graph of 2 to 12 steps. The entry step waits for the first
        reply and sends nothing. See the reply flows guide for step and branch
        shapes.
      properties:
        entryNodeId:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$
          description: |-
            Identifier for the entry node.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Pattern | `^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$` |
        nodes:
          type: array
          minItems: 2
          maxItems: 12
          items:
            type: object
            additionalProperties: false
            required:
              - id
              - edges
            properties:
              id:
                type: string
                pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$
                description: |-
                  Identifier for this resource.

                  <!-- polymorfa-input-table -->
                  **Value constraints**
                  | Constraint | Accepted input |
                  | --- | --- |
                  | Pattern | `^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$` |
              send:
                type: object
                required:
                  - kind
                additionalProperties: true
                description: >-
                  `text` (`text`), `buttons` (`body`, up to 3 `buttons` with
                  `id` and `text`), `list` (`body`, `buttonText`, up to 10
                  `rows`), or `flow_form` (`flowId`, `body`, `buttonText`,
                  `screen`; Official numbers only).
                properties:
                  kind:
                    type: string
                    enum:
                      - text
                      - buttons
                      - list
                      - flow_form
                    description: |-
                      Kind discriminator for this object.

                      <!-- polymorfa-input-table -->
                      **Allowed values**
                      | Value | Meaning |
                      | --- | --- |
                      | `text` | Text. |
                      | `buttons` | Buttons. |
                      | `list` | List. |
                      | `flow_form` | Flow form. |
              edges:
                type: array
                maxItems: 3
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - match
                    - to
                  properties:
                    match:
                      type: object
                      required:
                        - kind
                      additionalProperties: true
                      description: >-
                        `choice` (`replyKind` `button` or `list`, `id`),
                        `keyword` (`value`), or `flow_submission`.
                      properties:
                        kind:
                          type: string
                          enum:
                            - choice
                            - keyword
                            - flow_submission
                          description: |-
                            Kind discriminator for this object.

                            <!-- polymorfa-input-table -->
                            **Allowed values**
                            | Value | Meaning |
                            | --- | --- |
                            | `choice` | Choice. |
                            | `keyword` | Keyword. |
                            | `flow_submission` | Flow submission. |
                    to:
                      type: string
                      description: Specifies to for this edge.
                description: |-
                  Edges associated with this node.

                  <!-- polymorfa-input-table -->
                  **Value constraints**
                  | Constraint | Accepted input |
                  | --- | --- |
                  | Array size | At most `3` items |
          description: >-
            Nodes associated with this management platform campaign reply flow
            definition.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Array size | `2` through `12` items |
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
            request_id:
              type: string
              description: >-
                Matches the X-Request-Id response header. Include it when you
                contact support.
            request_log_url:
              type: string
              format: uri
              description: >-
                Console page that shows this request. Returned only to
                organization and project credentials whose request was logged.


                <!-- polymorfa-input-table -->

                **Value constraints**

                | Constraint | Accepted input |

                | --- | --- |

                | Format | `uri` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__NotFound:
      description: >-
        The requested resource was not found inside the authenticated team or
        project scope.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        X-Trace-Id:
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
          description: >-
            W3C trace ID of this request. Your `traceparent` trace ID when you
            sent a valid one.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Send your team API key or project token as `Authorization: Bearer
        <token>`. The credential must have the required permissions. Project
        tokens can access only their own project.

````

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