Sign in

v12

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

Get a session

Returns one session for the Session Inspector: session lifecycle + phone display fields + workflow name (when tied to one) + an inlined presigned recording URL. Works for active and terminal sessions, and for workflow runs and workflow-less interactive leases. Org-scoped: another org's session reads as not found.

get/phones/sessions/{session_id}

Path parameters

session_idstring uuid required

Phone session identifier

Phone session identifier

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

allocated_atstring date-time required

When the session claimed the phone.

allocated_by'workflow_editor' | 'dashboard_run' | 'api_run' | 'interactive'

How the session was started.

deallocated_atstring date-time

When the session released the phone; absent while active.

is_dedicated_phoneboolean required

Whether the phone is a dedicated (rented) phone.

locationstring

Physical hosting location of the phone.

model_namestring

Hardware model name of the phone.

namestring

Optional user-chosen session label; unique among the org's active sessions.

nicknamestring

User-assigned phone nickname.

phone_idstring required

Phone the session ran on.

phone_namestring

Display name of the phone.

phone_status'active' | 'inactive' | 'maintenance' | 'suspended' required

Fleet status of the phone.

phone_type'android' | 'iphone' | 'unknown'

Platform of the phone.

recording_status'ready' | 'pending' | 'expired' required

'ready' when the recording URL is present, 'pending' while the recording is still being processed, or 'expired' when it is past the plan's recording retention window.

recording_urlstring

Playback URL for the session recording, set only when ready.

session_idstring required

Session identifier.

source'workflow' | 'interactive' required

'workflow' when tied to a workflow, else 'interactive'.

status'active' | 'completed' | 'cancelled' | 'expired' required

Session lifecycle status.

tagsobject

Optional key->value labels attached to the session.

workflow_idstring

Workflow the session executed, when source is 'workflow'.

workflow_namestring

Name of the workflow the session executed.

Example response

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