Skip to content
Get started

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
client.workspaceAdmin.members.list(stringworkspaceID, MemberListParams { cursor, limit } query?, RequestOptionsoptions?): CursorPagination<WorkspaceMember { actorId, profileId, addedAt, 2 more } >
GET/v1/account/workspaces/{workspaceId}/members
Add a member to a workspace
client.workspaceAdmin.members.add(stringworkspaceID, MemberAddParams { email, profileId } body, RequestOptionsoptions?): WorkspaceMember { actorId, profileId, addedAt, 2 more }
POST/v1/account/workspaces/{workspaceId}/members
Remove a member from a workspace
client.workspaceAdmin.members.remove(stringprofileID, MemberRemoveParams { workspaceId } params, RequestOptionsoptions?): void
DELETE/v1/account/workspaces/{workspaceId}/members/{profileId}