API Docs
Users & Roles
API ReferenceUsers

Users & Roles

Manage the people on your team who have access to the merchant dashboard. Users are scoped to one or more merchants/organisations and each one carries a role that decides what they can do (view, manage payments, manage connectors, manage other users, etc.).

Lifecycle

  1. Invite. POST /user/user/invite_multiple sends an email with a one-time link. The user is created in invitation_sent state.
  2. Accept. The recipient clicks the link, sets a password, optionally TOTP, and lands on the dashboard. State moves to active.
  3. Update role. POST /user/user/update_role changes the user's role in place.
  4. Resend invite. POST /user/user/resend_invite generates a fresh link if the original expired.
  5. Remove. DELETE /user/user/delete revokes access.

Endpoints

OperationMethodPath
List usersGET/user/user/list
List invitable rolesGET/user/role/list/invite
Invite usersPOST/user/user/invite_multiple
Update user rolePOST/user/user/update_role
Resend invitePOST/user/user/resend_invite
Delete userDELETE/user/user/delete