v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB
phones

List active sessions

Returns one page of the organization's currently-active phone sessions joined with phone + workflow display fields: in-flight runs, workflow-less interactive leases, and dedicated phones in use. Paginated via limit (default 25, max 100) + offset; the response total is the full active count.

get/phones/sessions/active

Query parameters

limitinteger

max rows to return (default 25, max 100)

max rows to return (default 25, max 100)

offsetinteger

rows to skip for pagination

rows to skip for pagination

searchstring

case-insensitive match on phone name/nickname/id, session id, or workflow name

case-insensitive match on phone name/nickname/id, session id, or workflow name

dedicatedstring

filter by ownership: 'dedicated' or 'shared'

filter by ownership: 'dedicated' or 'shared'

sourcestring

filter by source: 'workflow' or 'interactive'

filter by source: 'workflow' or 'interactive'

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Number of active allocations.

Example response

{
  "$schema": "/api/v1/PhoneActiveSessionsResponse.json"
}