List exit paths

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/playbook-path \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "paths": [
    {
      "id": "<string>",
      "playbookID": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2026-09-10T00:00:00.000Z",
      "updatedAt": "2026-09-10T00:00:00.000Z"
    }
  ]
}

List exit paths

Returns every exit path of one playbook in one response. An exit path is a named way out of a playbook that the model takes when its exit condition holds, and workflows use its ID to link the path’s port.

GET

/v1/stable/playbook-path

List exit paths

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/playbook-path \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "paths": [
    {
      "id": "<string>",
      "playbookID": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2026-09-10T00:00:00.000Z",
      "updatedAt": "2026-09-10T00:00:00.000Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Query Parameters

projectID

string

required

The ID of the project to operate on.

environmentAlias

string

required

The alias of the environment to operate on (e.g. main).

playbookID

string

required

The ID of the playbook the exit path belongs to.

Response

200 - application/json

Returns the exit paths of the playbook, each with its ID, name, exit condition and timestamps.

paths

object[]

required

Show child attributes

string

required

playbookID

string

required

The ID of the playbook this exit path belongs to.

name

string

required

The name of the exit path. It labels the port on every Playbook step that runs this playbook, and the runtime turns it into the name of the exit tool the model calls.

description

string

required

The exit condition: the model reads it to decide when to leave the playbook through this path.

createdAt

string

required

updatedAt

string

required

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

List exit paths

Authorizations

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks