Skip to content
Vendrix
Sign in

Status

Check that a key works and see what it can do.

These examples use a placeholder address. Your console shows the exact address of the API for your workspace.

GET /status

Returns the application, the environment and the scopes of the key. The capabilities list holds the scopes of this key that the API implements.

Required scope
system.status.read
HTTP
Success: HTTP 200

Parameters

This endpoint takes no parameters.

Any authenticated endpoint can also return the authentication, scope and rate limit errors listed on the errors page.

Request

curl "https://api.vendrix.net/v1/status" \
  -H "Authorization: Bearer $VENDRIX_API_KEY"

Response

200 OK
{
  "status": "authenticated",
  "application_id": "9c1d2e3f-4a5b-4c6d-8e7f-a0b1c2d3e4f5",
  "workspace_id": "3a4b5c6d-7e8f-4a9b-b0c1-d2e3f4a5b6c7",
  "environment": "live",
  "scopes": [
    "system.status.read",
    "connections.read",
    "messages.send"
  ],
  "timestamp": "2026-10-14T09:30:00Z",
  "capabilities": [
    "system.status.read",
    "connections.read",
    "messages.send"
  ],
  "sandbox_external_calls": false
}