Workspace Admin

Administer workspaces across the account: create and archive workspaces and manage their membership. These operations are account-scoped and require the admin role (a token whose profile holds the WorkOS admin role); they live under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces tree so an admin can manage any workspace in the account, including ones they are not themselves a member of.

List all workspaces in the account

GET/v1/account/workspaces

Create a workspace

POST/v1/account/workspaces

Get a workspace by ID

GET/v1/account/workspaces/{workspaceId}

Update a workspace

PATCH/v1/account/workspaces/{workspaceId}

Archive a workspace

DELETE/v1/account/workspaces/{workspaceId}

ModelsExpand Collapse

WorkspaceMember object { actorId, profileId, addedAt, 2 more }

A member of a workspace: the profile granted access plus the actor row that links it to the workspace. Returned by member list/add operations.

actorId: string

The actor row linking the profile to the workspace (the junction record).

profileId: string

The account profile that has access to the workspace.

addedAt: optional string

When the member was added to the workspace.

formatdate-time

email: optional string

Email address of the member’s profile.

name: optional string

Display name of the member’s profile.

Workspace AdminMembers

Administer workspaces across the account: create and archive workspaces and manage their membership. These operations are account-scoped and require the admin role (a token whose profile holds the WorkOS admin role); they live under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces tree so an admin can manage any workspace in the account, including ones they are not themselves a member of.

List workspace members

GET/v1/account/workspaces/{workspaceId}/members

Add a member to a workspace

POST/v1/account/workspaces/{workspaceId}/members

Remove a member from a workspace

DELETE/v1/account/workspaces/{workspaceId}/members/{profileId}

Workspace AdminProfiles

Administer workspaces across the account: create and archive workspaces and manage their membership. These operations are account-scoped and require the admin role (a token whose profile holds the WorkOS admin role); they live under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces tree so an admin can manage any workspace in the account, including ones they are not themselves a member of.

Search account profiles

GET/v1/account/profiles