See whom a call rings

GET
/v1/handoff/settings

The workspace's handoff routing: the numbers to ring in the day and outside it, how long each rings, the key that takes the call, the schedule, where a call's ask goes (a phone, a teammate in the dashboard, or both) and where a text ask goes (your inbox or an outside desk). canEdit says whether the caller may change them.

Requires an API key with the workspace:read scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Response Body

The workspace's handoff routing settings

application/json
  1. response
settings*
canEdit*boolean

Whether the caller may change them: an admin, or an app connected with Everything.

updatedAt*string|null
updatedBy*string|null
Example Request
curl https://api.vlayers.ai/v1/handoff/settings \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "settings": {    "dayNumbers": [      {        "number": "+14155550142",        "label": "Store"      }    ],    "onCallNumbers": [],    "ringSeconds": 20,    "acceptKey": "1",    "schedule": null,    "urgentWhen": "",    "followUpMessage": null,    "nobodyFreeMessage": null,    "onTimeout": "offer_follow_up",    "honourRequestForPerson": false,    "callDestination": "phone",    "dashboardSchedule": null,    "dashboardWaitSeconds": 30,    "teammateListensFirst": false,    "contextTranscript": "off",    "textDestination": "inbox",    "deskConnectionId": null  },  "canEdit": true,  "updatedAt": "2026-10-20T15:04:05.000Z",  "updatedBy": "user_2abc"}