Get path

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

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

import requests

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

{
  "path": {
    "id": "<string>",
    "name": "<string>",
    "label": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "functionID": "<string>"
  }
}

Get path

Returns a single function path by ID, with the fields that define it. A function path is one of the named exits a function can return through.

GET

/v1/stable/function-path/{pathID}

Get path

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

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

import requests

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

{
  "path": {
    "id": "<string>",
    "name": "<string>",
    "label": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "functionID": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

pathID

string

required

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).

Response

200 - application/json

Returns one exit path, including the function it belongs to, the name its code returns to select it, and the label displayed for it.

path

object

required

Show child attributes

string

required

name

string

required

The name of the exit path, referenced by the function code when returning which path to take.

label

string

required

The display label shown for this path in the Voiceflow UI; falls back to name when null.

createdAt

string

required

updatedAt

string

required

functionID

string

required

The ID of the function this path belongs to.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Get path

Authorizations

Path Parameters

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks