Endpoints
Users
API reference for managing users, invitations, and role assignments.
Overview
The Users API manages tenant members and invitations. Invite new users, manage roles, and control access across your organization.
List Tenant Members
GET /tenants/{tenantId}/members — Retrieve all members in the tenant with their roles and status. Returns user profile information, tenant role, and invitation status.
Invite Members
POST /tenants/{tenantId}/invitations — Send an invitation email. Body: { email: string, role: string, workspaceIds?: string[] }. The invitee receives an email with a link to accept. Pending invitations can be listed, resent, or revoked.
Update Member Role
PATCH /tenants/{tenantId}/members/{userId}/role — Change a member's tenant-level role. Available roles: tenant_owner, tenant_admin, user. Only tenant owners can promote others to owner or admin.
Remove Member
DELETE /tenants/{tenantId}/members/{userId} — Remove a member from the tenant. They lose access to all workspaces. Their contributed content (documents, workflows) is preserved.