Skip to main content

Overview

Workspaces endpoints

Available Operations

list

List all workspaces for the authenticated user. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.ListWorkspacesResponse>

Errors

create

Create a new workspace for the authenticated user. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.CreateWorkspaceResponse>

Errors

delete

Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted; remove the keys first. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.DeleteWorkspaceResponse>

Errors

get

Get a single workspace by ID or slug. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.GetWorkspaceResponse>

Errors

update

Update an existing workspace by ID or slug. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.UpdateWorkspaceResponse>

Errors

listBudgets

List all budgets configured for a workspace. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.ListWorkspaceBudgetsResponse>

Errors

deleteBudget

Remove the budget for a given interval. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.DeleteWorkspaceBudgetResponse>

Errors

setBudget

Create or update the budget for a given interval. Budget limits must strictly decrease as the interval narrows (lifetime > monthly > weekly > daily). Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.UpsertWorkspaceBudgetResponse>

Errors

listMembers

List all members of a workspace. Returns paginated results. For the default workspace, returns all organization members (implicit membership). Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.ListWorkspaceMembersResponse>

Errors

bulkAddMembers

Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.BulkAddWorkspaceMembersResponse>

Errors

bulkRemoveMembers

Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. SCIM-managed members cannot be removed; changes must be made in your identity provider. Management key required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.BulkRemoveWorkspaceMembersResponse>

Errors