Workspace.Members.Crud

Tags: members, users

Endpoints

• POST /members - Members
• POST /members/import - Import
• DELETE /members/{member_id} - Delete Members
• GET /members/{member_id} - Members
• PUT /members/{member_id} - Update Members
• POST /members/{member_id}/archive - Archive
• POST /members/{member_id}/phone-confirmation - Phone Confirmation
• POST /members/{member_id}/unarchive - Unarchive

Members

POST /api/v2/w/{workspace_uuid}/members

Description:

Workspace member management

Create a new workspace member.

Authorization: Requires members:write scope

Parameters:

• request - See CreateWorkspaceMemberRequest

Response: See WorkspaceMemberResponse

---

Import

POST /api/v2/w/{workspace_uuid}/members/import

Description:

Workspace member management

Import members from CSV file with streaming progress updates.

Authorization: Requires members:admin scope

Parameters:

• file (UploadFile)
• new_member_role_id (Integer)
• trust_email_addresses (Boolean)
• trust_phone_numbers (Boolean)

---

Delete Members

DELETE /api/v2/w/{workspace_uuid}/members/{member_id}

Description:

Workspace member management

Permanently delete a workspace member and all their associated data.

Important: Members must be archived first before deletion. Use the archive endpoint to safely remove a member from the workspace. Permanent deletion is a destructive operation that cannot be undone.

The force flag allows workspace managers to auto-archive before deletion. Without force, this endpoint is restricted to superusers for erasure scenarios.

Authorization: Requires members:admin scope

Parameters:

• member_id (Integer)
• reassign_to_id (Integer)
• force (Boolean)

Response: See DeleteMembershipResponse

---

Members

GET /api/v2/w/{workspace_uuid}/members/{member_id}

Description:

Workspace member management

Get a workspace member by ID.

Self-access: Users can view their own member profile. Admin access: MEMBERS_READ scope required for viewing other members.

Authentication: Requires workspace member

Parameters:

• member_id (Integer)

Response: See WorkspaceMemberResponse

---

Update Members

PUT /api/v2/w/{workspace_uuid}/members/{member_id}

Description:

Workspace member management

Update a workspace member.

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)
• request - See UpdateWorkspaceMemberRequest

Response: See WorkspaceMemberResponse

---

Archive

POST /api/v2/w/{workspace_uuid}/members/{member_id}/archive

Description:

Workspace member management

Archive a workspace member instead of deleting them.

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)

Response: See WorkspaceMemberResponse

---

Phone Confirmation

POST /api/v2/w/{workspace_uuid}/members/{member_id}/phone-confirmation

Description:

Workspace member management

Text a member asking them to confirm their phone (member-attested trust).

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)

Response: See SendPhoneConfirmationResponse

---

Unarchive

POST /api/v2/w/{workspace_uuid}/members/{member_id}/unarchive

Description:

Workspace member management

Unarchive a previously archived workspace member.

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)

Response: See WorkspaceMemberResponse

---