Salesforce Flow Flow Interviews API

openapi: 3.1.0
info:
  title: Salesforce Flow REST Flow Definitions Flow Interviews API
  description: REST API for managing and executing Salesforce Flows programmatically. Enables creating, updating, querying, and executing flow automation processes, flow interviews, and invocable actions within Salesforce.
  version: 59.0.0
  termsOfService: https://www.salesforce.com/company/legal/agreements/
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v59.0
  description: Salesforce Production or Developer Edition
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Flow Interviews
  description: Operations for executing and managing Flow interviews
paths:
  /sobjects/FlowInterview:
    post:
      operationId: createFlowInterview
      summary: Create Flow Interview
      description: Creates and starts a new Flow Interview (a running instance of a Flow). Optionally passes input variables to initialize the Flow.
      tags:
      - Flow Interviews
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlowInterviewInput'
      responses:
        '201':
          description: Flow Interview created and started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResponse'
        '400':
          description: Invalid request or Flow not found
  /sobjects/FlowInterview/{interviewId}:
    get:
      operationId: getFlowInterview
      summary: Get Flow Interview
      description: Retrieves the current state, status, and output variables of a running or completed Flow Interview.
      tags:
      - Flow Interviews
      parameters:
      - name: interviewId
        in: path
        required: true
        description: The unique Salesforce ID of the FlowInterview record
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved flow interview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowInterview'
        '404':
          description: Interview not found
    delete:
      operationId: deleteFlowInterview
      summary: Delete Flow Interview
      description: Deletes a Flow Interview record. Typically used for paused interviews that are no longer needed.
      tags:
      - Flow Interviews
      parameters:
      - name: interviewId
        in: path
        required: true
        description: The unique Salesforce ID of the FlowInterview record
        schema:
          type: string
      responses:
        '204':
          description: Interview deleted successfully
        '404':
          description: Interview not found
components:
  schemas:
    FlowInputVariable:
      type: object
      properties:
        name:
          type: string
          description: Variable name
        value:
          description: Variable value (any type)
    CreateResponse:
      type: object
      properties:
        id:
          type: string
          description: Salesforce record ID of the created resource
        success:
          type: boolean
        errors:
          type: array
          items:
            type: string
    FlowInterview:
      type: object
      properties:
        Id:
          type: string
        CurrentElement:
          type: string
          description: Name of the current flow element
        GuidedFlowName:
          type: string
        HasFinished:
          type: boolean
        Name:
          type: string
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/FlowOutputVariable'
    FlowInterviewInput:
      type: object
      required:
      - FlowDefinitionView
      properties:
        FlowDefinitionView:
          type: object
          properties:
            ApiName:
              type: string
              description: API name of the flow to start
        inputs:
          type: array
          description: Input variable values for the flow
          items:
            $ref: '#/components/schemas/FlowInputVariable'
    FlowOutputVariable:
      type: object
      properties:
        name:
          type: string
        value:
          description: Output variable value
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your data
            full: Full access
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Salesforce Flow REST API Developer Guide
  url: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_flow.htm