Get customer flow by ID

Returns a customer flow with its happy path, edge cases, expectations and linked agents. Scripted flows also carry their step graph.

get/v1/customer-flow/{flowId}

Path parameters

flowIdstring uuid required

Response

The requested customer flow

Example response

{
  "data": {
    "happyPath": {
      "personaOverride": {
        "backstoryPrompt": "A busy professional calling during lunch break",
        "properties": {
          "age": 35,
          "zipCode": "94105",
          "occupation": "Software Engineer"
        }
      }
    },
    "edgeCases": [
      {
        "personaOverride": {
          "backstoryPrompt": "A busy professional calling during lunch break",
          "properties": {
            "age": 35,
            "zipCode": "94105",
            "occupation": "Software Engineer"
          }
        }
      }
    ]
  }
}

Changes

Changed in 2 of the 105 revisions of this API.7

Aug 26, 2026b4a59c7057ca6See the full diff
- ○
  added the required property data/oneOf[subschema #1: Scripted]/edgeCases/items/personaOverride/age to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/oneOf[subschema #1: Scripted]/happyPath/oneOf[subschema #1: Scripted]/allOf[subschema #1: Scripted]/personaOverride/age to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/oneOf[subschema #2: Improv]/edgeCases/items/personaOverride/age to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/oneOf[subschema #2: Improv]/happyPath/oneOf[subschema #1: Improv]/allOf[subschema #1: Improv]/personaOverride/age to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/oneOf[subschema #3: Voicemail]/edgeCases/items/personaOverride/age to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/oneOf[subschema #3: Voicemail]/happyPath/oneOf[subschema #1: Voicemail]/allOf[subschema #1: Voicemail]/personaOverride/age to the response with the 200 status
  response-required-property-added
Aug 17, 2026887b091b3d811See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history