Users API
Reading and managing workspace members, inviting users, updating roles, and managing groups via API.
Overview
The Users API allows you to read and manage workspace members programmatically. Write operations require the admin scope.
List Users
- GET
/v1/users— returns a paginated list of all workspace members. - Supported filters:
role,status(active | deactivated),group_id,email.
Invite a User
- POST
/v1/users/invite— sends an invitation to one or more email addresses. - Body:
{ "emails": ["user@example.com"], "role": "member" }
Groups
- GET
/v1/groups— list all groups. - POST
/v1/groups— create a group. - POST
/v1/groups/{group_id}/members— add users to a group.