Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB
User and Workspace management

Add Member to Workspace

Add an existing user to a workspace.

  • You must be an organization admin or a workspace admin to add members.
post/public/v1/workspaces/{workspace_id}/members

Path parameters

workspace_idstring required

Query parameters

notify_userboolean

Send a confirmation email to the user that was added to workspace(s).

notify_ws_adminsboolean

Send a confirmation email to all workspace admins indicating that the user has been added to the workspace.

Request body

user_idstring required

User id.

role'Admin' | 'Manager' | 'Member' | 'Collaborator' required

Role for a member.

Example request

{
  "user_id": "2eWSKSvVqmuVCnuUK3iWwD",
  "role": "Member"
}

Response

OK

member_idstring
workspace_idstring
role'Admin' | 'Manager' | 'Member' | 'Collaborator'

Role for a member.

emailstring
first_namestring
last_namestring

Example response

{
  "member_id": "iMymdDd9XFD3HyxP5VD67Q",
  "workspace_id": "2eWSKSvVqmuVCnuUK3iWwD",
  "role": "Member",
  "email": "email@example.com",
  "first_name": "John",
  "last_name": "Doe"
}