client.workspaceOperation 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.
/workspaceworkspace.get
Use this operation to get the authenticated workspace. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.workspace.get(options?: RequestOptions)- Return form
Promise- Operation ID
getWorkspace- Required scopes
workspace:read- SDK parameters
options: RequestOptions- Success
200 Workspace envelope
/workspace/entitlementsworkspace.getEntitlements
Returns stable public capability identifiers and entitlement state without raw plan, billing, feature-group, or role details.
client.workspace.getEntitlements(options: RequestOptions = {})- Return form
Promise- Operation ID
getWorkspaceEntitlements- Required scopes
workspace:read- SDK parameters
options: RequestOptions- Success
200 Array<WorkspaceEntitlement> 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.