API Reference

Workspace Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Members

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

workspace_admin.members.list(workspace_id, **kwargs) -> CursorPagination<WorkspaceMember { actor_id, profile_id, added_at, 2 more } >

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

Add a member to a workspace

workspace_admin.members.add(workspace_id, **kwargs) -> WorkspaceMember { actor_id, profile_id, added_at, 2 more }

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

Remove a member from a workspace

workspace_admin.members.remove(profile_id, **kwargs) -> void

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