Connection

Use an API key or REST OAuth access token. Scopes and your current workspace permissions apply together. All examples are illustrative.

Verify connected workspace

GET /api/external/v1/connection

Scope: connection:verify

Response 200

Success.

Header	Type	Description
Cache-Control	string	The response must not be cached. Example: no-store

application/json

FieldsExample

Field	Type	Description
connected	boolean	Whether the credential is connected to the workspace.
tenantId	string (uuid)	ID of the workspace bound to the credential.
tenantName	string	Name of the workspace bound to the credential.
scopes	List of string	Scopes granted to this credential.

{
  "connected": true,
  "tenantId": "00000000-0000-0000-0000-000000000001",
  "tenantName": "Example workspace",
  "scopes": []
}

Error responses

Status	Meaning
400	Invalid input, unsupported selection or time range.
401	Missing, expired or invalid credential. The body may be empty.
403	Required scope or current user permission missing. The body may be empty.
429	Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503	Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field	Type	Description
status	integer	HTTP status code.
error	string	Description of the error.
details	any	Additional error details, when available. Rules: null allowed
code	string	Machine-readable error code.
params	object	Additional values associated with the error code.
fieldErrors	object	Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.