ROroarkhq
Customer Flow

List customer flows

Changed on

Returns a paginated list of customer flows with their agents, expectations, happy path and edge cases. The step graph is the one field omitted: reading it walks the project's whole step graph, so it comes back from the single-flow endpoint instead. Customer flows are how a project describes what to test; they replace the older simulation scenarios.

get/v1/customer-flow

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/customer-flow
  • Auth
    HTTP bearer

Query parameters

limitinteger
afterstring
searchTextstring
type'SCRIPTED' | 'IMPROV' | 'VOICEMAIL'
includeSystem'true' | 'false'

Response

List of customer flows

Example response

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

Changes

  • f747fc3e482cRevision changes
    • info

      added the required property ///// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ////// to the response with the status

  • e32b31fc8f98Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status