User roles and permissions - 2026-03-26

Roles are deprecated from the /users API and separated into their own /roles and /user-scope API resources to align Guesty's Open API with the latest roles and permissions version supported by the platform.


Added

  • Add GET /roles to retrieve a list of supported user roles and permissions
  • Add GET /roles/:id to retrieve the roles and permissions assigned to a user
  • Add POST /roles/assign to assign roles and permissions to a user
  • Add POST /user-scope/assign to assign the scope of listing permissions to a user
  • Add GET /user-scope/:id to retrieve the scope of listing permissions assigned to a user

Changed

  • Add optional country request property to POST /users
  • Add optional registrationOrigin request property to POST /users

Removed

  • Breaking: deprecated the roles property from the /user endpoints. Update your integrations to utilise the /roles and /user-scope APIs to manage user roles and permissions instead