List outside desks

GET
/v1/desks

The outside desks a workspace can connect (a desk is a place a person answers a text conversation that VoiceLayer keeps relaying) and this workspace's desk connections, each with the addresses to point the desk at. Setup runs through the ordinary connection and onboarding routes. Nothing secret is in the answer.

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 outside desks you can connect, and your desk connections with the addresses to point each desk at

application/json
  1. response
desks*array<>
connections*array<>
Example Request
curl https://api.vlayers.ai/v1/desks \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "desks": [    {      "id": "vl/helpdesk",      "displayName": "Example desk",      "publisher": "VoiceLayer",      "version": "1.0.0",      "consoleUrl": null,      "workflow": {        "version": 1,        "steps": []      }    }  ],  "connections": [    {      "id": "0192f5b0-7c3e-7a51-9b2d-4e8f1a6c3d21",      "connectorId": "vl/helpdesk",      "displayName": "Support desk",      "status": "active",      "hooks": [        {          "label": "Webhook",          "help": null,          "url": null        }      ]    }  ]}