Salesforce Flow · Example Payload

Salesforce Flow List Flows Example

Example request and response for listing Flow definitions

AutomationBusiness ProcessCRMFlowProcess BuilderSalesforceWorkflow

Salesforce Flow List Flows Example is an example object payload from Salesforce Flow, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionoperationmethodpathrequestresponse

Example Payload

{
  "title": "List Flow Definitions Example",
  "description": "Example request and response for listing Flow definitions",
  "operation": "listFlows",
  "method": "GET",
  "path": "/sobjects/Flow",
  "request": {
    "headers": {
      "Authorization": "Bearer {access_token}",
      "Accept": "application/json"
    }
  },
  "response": {
    "statusCode": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "totalSize": 3,
      "done": true,
      "records": [
        {
          "Id": "300xx000000bpCAAQ",
          "ApiName": "Account_Onboarding_Flow",
          "Label": "Account Onboarding Flow",
          "ProcessType": "Flow",
          "Status": "Active",
          "VersionNumber": 3
        },
        {
          "Id": "300xx000000bpDBBR",
          "ApiName": "Lead_Qualification_Flow",
          "Label": "Lead Qualification Flow",
          "ProcessType": "AutoLaunchedFlow",
          "Status": "Active",
          "VersionNumber": 1
        },
        {
          "Id": "300xx000000bpECC5",
          "ApiName": "Case_Escalation_Flow",
          "Label": "Case Escalation Flow",
          "ProcessType": "AutoLaunchedFlow",
          "Status": "Draft",
          "VersionNumber": 2
        }
      ]
    }
  }
}