Skip to main content

Get Users By Role

GET 

/v1/users/role/:role

Return users with the selected role. Use one of the user-role values defined in the response and request schemas.

Requires users.read.

Request and response fields at a glance
  • Path parameters: role (string, required).
  • 200 response (application/json): array of id (number, required), email (string, required), name (string), nameAr (mixed), nameEn (mixed), phone (mixed), phoneCountry (mixed), role (string, required), organizationId (number), logoUrl (string), status (string, required), lastSignInAt (mixed, required), createdAt (string, required), updatedAt (string, required), organization (object), permissions (array).

Request​