Team, roles & invites

Role-based access control for multi-user accounts - system roles, custom roles, and inviting teammates.

GET/rolesroles.manage

List roles - the 4 system roles (Owner, Admin, Manager, Member) plus any custom roles.

POST/rolesroles.manage

Create a custom role with a specific set of permissions.

PATCH/roles/:idroles.manage

Update a custom role. System roles can't be edited.

DELETE/roles/:idroles.manage

Delete a custom role. System roles can't be deleted.

GET/permissions

The full permission key list, for building a role editor.

GET/usersusers.manage

List the account's users.

PATCH/users/:idusers.manage

Update a user (role, status). Refuses to suspend the account's last active user.

DELETE/users/:idusers.manage

Remove a user. Refuses to remove the account's last active user.

GET/invitesusers.manage

List pending invites.

POST/invitesusers.manage

Send an email or SMS invite to join the account, with a role pre-assigned.

POST/invites/:id/resendusers.manage

Resend an invite that was missed.

DELETE/invites/:idusers.manage

Revoke a pending invite.