> ## Documentation Index > Fetch the complete documentation index at: https://docs.roark.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get customer flow by ID > Returns a customer flow with its variants, expectations and linked agents. Scripted flows also carry their step graph. ## OpenAPI ````yaml /api-reference/openapi.documented.json get /v1/simulation/customer-flow/{flowId} openapi: 3.1.0 info: title: Roark Analytics API description: >- The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform. version: 1.0.0 servers: - description: Production url: https://api.roark.ai security: - Bearer: [] tags: - name: Agent - name: Agent Endpoint - name: Call - name: Chat - name: Metric - name: Metric Policy - name: Metric Collection Job - name: Simulation Persona - name: Simulation Environment - name: Simulation Customer Flow - name: Simulation Customer Flow Variant - name: Simulation Scenario - name: Simulation Run Plan - name: Simulation Run Plan Job - name: Simulation Job - name: HTTP Request Definition - name: Webhook - name: Issue - name: Knowledge Base - name: Call Analysis - name: Health paths: /v1/simulation/customer-flow/{flowId}: get: tags: - Simulation Customer Flow summary: Get customer flow by ID description: >- Returns a customer flow with its variants, expectations and linked agents. Scripted flows also carry their step graph. operationId: getV1SimulationCustomer-flowByFlowId parameters: - in: path name: flowId schema: type: string format: uuid required: true responses: '200': description: The requested customer flow content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CustomerFlowResponse' required: - data '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Permission error example: type: forbidden code: permission_denied message: You do not have permission to access this resource description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Not found error example: type: not_found code: resource_not_found message: The requested resource could not be found description: Not Found '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit error example: type: rate_limit code: too_many_requests message: Rate limit exceeded description: Too Many Requests '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Server error example: type: internal code: internal_error message: Internal server error description: Internal Server Error x-codeSamples: - lang: JavaScript source: |- import Roark from '@roarkanalytics/sdk'; const client = new Roark({ bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted }); const response = await client.simulationCustomerFlow.getByID( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response.data); - lang: Python source: |- import os from roark_analytics import Roark client = Roark( bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted ) response = client.simulation_customer_flow.get_by_id( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(response.data) components: schemas: CustomerFlowResponse: type: object properties: id: type: string format: uuid title: type: string minLength: 1 description: type: - string - 'null' mode: type: string enum: - UNSCRIPTED - SCRIPTED - VOICEMAIL scriptedBranchingMode: type: string enum: - DETERMINISTIC - ADAPTIVE default: DETERMINISTIC source: type: string enum: - SYSTEM - CUSTOM default: CUSTOM systemKey: type: - string - 'null' startNodeId: type: - string - 'null' format: uuid createdAt: type: string description: Creation timestamp in ISO 8601 format updatedAt: type: string description: Last update timestamp in ISO 8601 format agentIds: type: array items: type: string format: uuid description: Agents this flow exercises agentExpectations: type: array items: $ref: '#/components/schemas/FlowExpectationResponse' variants: type: array items: $ref: '#/components/schemas/FlowVariantResponse' steps: type: array items: $ref: '#/components/schemas/FlowStep' description: The conversation, as a tree of steps. Scripted flows only. stepsSharedWithOtherFlows: type: array items: type: string format: uuid description: >- Steps that another flow also uses. Removing one of these detaches it from this flow rather than deleting it, so the other flow keeps working. required: - id - title - mode - scriptedBranchingMode - source - startNodeId - createdAt - updatedAt - agentIds - agentExpectations - variants description: >- A customer flow: the conversation a simulated customer has with the agent under test. Flows with source SYSTEM are curated by Roark, shared across projects, and read-only. ErrorResponse: type: object properties: type: type: string enum: - validation - authentication - forbidden - not_found - conflict - payment_required - rate_limit - internal description: The error type category examples: - validation - authentication code: type: string description: Machine-readable error code identifier examples: - invalid_parameter - missing_required_field - unauthorized message: type: string description: Human-readable error message examples: - The request was invalid - Authentication required param: type: string description: The parameter that caused the error (if applicable) examples: - email - user_id details: description: Additional error context information required: - type - code - message FlowExpectationResponse: type: object properties: id: type: string format: uuid llmPrompt: type: string orderIndex: type: integer default: 0 sourceStepNodeId: type: - string - 'null' format: uuid required: - id - llmPrompt - orderIndex - sourceStepNodeId description: >- An expectation the agent under test is graded against. On a scripted flow these are derived from the agent turns in the graph, so they are read-only there. FlowVariantResponse: type: object properties: id: type: string format: uuid customerFlowId: type: string format: uuid title: type: string minLength: 1 isDefault: type: boolean default: false personaId: type: - string - 'null' format: uuid environmentId: type: - string - 'null' format: uuid prompt: type: - string - 'null' latestPathId: type: - string - 'null' format: uuid precededByCustomerFlowId: type: - string - 'null' format: uuid precededByCustomerFlowVariantId: type: - string - 'null' format: uuid isGenerated: type: boolean default: false isAutoGeneratedTitle: type: boolean default: false createdAt: type: string description: Creation timestamp in ISO 8601 format updatedAt: type: string description: Last update timestamp in ISO 8601 format additionalExpectations: type: array items: $ref: '#/components/schemas/FlowExpectationResponse' required: - id - customerFlowId - title - isDefault - personaId - environmentId - latestPathId - precededByCustomerFlowId - precededByCustomerFlowVariantId - isGenerated - isAutoGeneratedTitle - createdAt - updatedAt - additionalExpectations description: >- One way of running a flow. Exactly one variant per flow is the default; the others inherit its persona and environment wherever they leave those unset. On a scripted flow each variant is bound to one path through the graph and the path engine owns that binding. FlowStep: type: object properties: nodeId: type: string format: uuid ref: type: string minLength: 1 maxLength: 64 type: type: string enum: - AGENT_TURN - CUSTOMER_TURN - CUSTOMER_FIRST_MESSAGE - CUSTOMER_SILENCE - CUSTOMER_DTMF - VOICEMAIL - SCENARIO_LINK content: type: - string - 'null' dtmfDigits: type: - string - 'null' silenceDurationSeconds: type: - integer - 'null' exclusiveMinimum: 0 linkedCustomerFlowId: type: - string - 'null' format: uuid linkedCustomerFlowVariantId: type: - string - 'null' format: uuid steps: type: array items: $ref: '#/components/schemas/FlowStep' mergeIntoNodeIds: type: array items: type: string minLength: 1 required: - type description: >- One step in a scripted flow's conversation. `nodeId` is the identity contract: include it to update the existing step, omit it to create a new one. A step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which names steps elsewhere in the same request that this step rejoins. Branches that come back together are represented that way rather than by repeating the shared step, so reading a flow, editing it and writing it back preserves it exactly. A merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in the same request. `ref` is a label you choose, it is request-local, and it is never stored or returned. Put the shared step inline under the first branch that reaches it and point the others at it: a top-level step is a root wired straight from the start of the flow, so a merge target parked there would also be reachable directly. securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ````