v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Activeflow

List all activeflows

Retrieve a list of all activeflows.

get/activeflows

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

Successful response

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "status": "running",
      "reference_type": "call",
      "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
      "reference_activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
      "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "webhook_uri": "https://example.com/webhooks/activeflow",
      "webhook_method": "POST",
      "current_action": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "next_id": "550e8400-e29b-41d4-a716-446655440000",
        "type": "talk",
        "tm_execute": "2026-01-15T09:30:00.000000Z"
      },
      "forward_action_id": "550e8400-e29b-41d4-a716-446655440000",
      "executed_actions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "next_id": "550e8400-e29b-41d4-a716-446655440000",
          "type": "talk",
          "tm_execute": "2026-01-15T09:30:00.000000Z"
        }
      ],
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}