Workspaces

Get Live Transfer Settings

The live warm-transfer target (RO-064): when a caller asks the AI voice agent for a person, the agent puts them on hold, dials this team line, briefs the teammate and connects them, if ``enabled`` and within ``availability``. Off until set. ``sip_available: false``: this server has no SIP trunk, so every handoff becomes a task note.

API key access

Needs the workspace:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/workspaces/current/transfer
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/workspaces/current/transfer" \  -H "X-Workspace-Id: string"
{
  "enabled": true,
  "phone_number": "string",
  "sip_uri": "string",
  "ring_timeout_seconds": 0,
  "availability": "business_hours",
  "hours": {},
  "sip_available": true,
  "configured": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}