Salesforce Flow · Schema

Salesforce Flow Interview

Schema for a Salesforce Flow Interview, representing a running instance of a Flow.

AutomationBusiness ProcessCRMFlowProcess BuilderSalesforceWorkflows

Properties

Name Type Description
Id string Salesforce record ID for the FlowInterview
Name string Auto-generated name for the interview
CurrentElement string API name of the current flow element being executed
GuidedFlowName string API name of the Flow being interviewed
HasFinished boolean Whether the flow interview has completed
OwnerId string Salesforce ID of the interview owner
PauseLabel string Label for the pause element if flow is paused
CreatedDate string Timestamp when the interview was created
LastModifiedDate string Timestamp when the interview was last modified
inputs array Input variables passed to the flow interview
outputs array Output variables returned by the flow interview
View JSON Schema on GitHub

JSON Schema

salesforce-flow-flow-interview-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/salesforce-flow/blob/main/json-schema/salesforce-flow-flow-interview-schema.json",
  "title": "Salesforce Flow Interview",
  "description": "Schema for a Salesforce Flow Interview, representing a running instance of a Flow.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "Salesforce record ID for the FlowInterview"
    },
    "Name": {
      "type": "string",
      "description": "Auto-generated name for the interview"
    },
    "CurrentElement": {
      "type": "string",
      "description": "API name of the current flow element being executed"
    },
    "GuidedFlowName": {
      "type": "string",
      "description": "API name of the Flow being interviewed"
    },
    "HasFinished": {
      "type": "boolean",
      "description": "Whether the flow interview has completed"
    },
    "OwnerId": {
      "type": "string",
      "description": "Salesforce ID of the interview owner"
    },
    "PauseLabel": {
      "type": "string",
      "description": "Label for the pause element if flow is paused"
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the interview was created"
    },
    "LastModifiedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the interview was last modified"
    },
    "inputs": {
      "type": "array",
      "description": "Input variables passed to the flow interview",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Variable name"
          },
          "value": {
            "description": "Variable value"
          }
        },
        "required": ["name"]
      }
    },
    "outputs": {
      "type": "array",
      "description": "Output variables returned by the flow interview",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Variable name"
          },
          "value": {
            "description": "Variable value"
          }
        }
      }
    }
  },
  "required": ["Id", "GuidedFlowName", "HasFinished"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/salesforce-flow-flow-interview"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.