Read a package's screens

GET
/v1/installs/{install}/screens

Returns the management screens the package declares, as data (tables, forms, buttons and status lines) and the role each action needs. A person uses them in the dashboard; actions run there, as the signed-in person, and not through a key.

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.

Path Parameters

install*string

The install id from GET /v1/installs.

Response Body

The package's management screens, as data, and the role each action needs

application/json
  1. response
screens*array<>
actions*
Example Request
curl "https://api.vlayers.ai/v1/installs/$INSTALL_ID/screens" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "screens": [    {      "id": "overview",      "title": "Overview",      "blocks": [        {          "type": "status",          "source": "health",          "title": "Health"        }      ]    }  ],  "actions": {    "health": {      "role": "member",      "method": "GET"    }  }}