GET
/
live_flows
/
{live_flow_id}
/
{
  "name": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "<string>",
  "current_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "steps": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "step_type": "START",
        "prompt_template": {
          "type": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "step_transitions": [
      {
        "source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "sessions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "steps_count": 123,
      "inputs": {},
      "error": "<string>",
      "status": "NEW",
      "flow_version": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "steps": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "step_type": "START",
            "prompt_template": {
              "type": "<string>"
            },
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "step_transitions": [
          {
            "source_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "target_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Current-Org-Id
string | null

Represents the current organisation ID for the user (example: 'org_u13TesTDumMyEe5P')

Api-key
string | null

Path Parameters

live_flow_id
string
required

Response

200
application/json

Successful Response

The response is of type object.