client.systemOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/system.getApiVersion
Use this operation to discover API v1. It returns public contract, version, regional endpoint, and capability metadata without requiring a credential.
client.system.getApiVersion(options?: RequestOptions)- Return form
Promise- Operation ID
getApiVersion- Required scopes
- None
- SDK parameters
options: RequestOptions- Success
200 ApiVersionEnvelope- Declared API errors
429
/system/capabilitiessystem.getCapabilities
Intersects public product capability identifiers with workspace entitlement and this credential’s granted scopes. Raw plan, billing, feature-group, role, and permission identifiers are never exposed.
client.system.getCapabilities(options: RequestOptions = {})- Return form
Promise- Operation ID
getSystemCapabilities- Required scopes
workspace:read- SDK parameters
options: RequestOptions- Success
200 Array<SystemCapability> envelope
Errors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.