infoodle

List all roles

GET /roles/list
OAuth2

The authenticated user must have the List Roles permission in the role. Once done, this gives a list of the roles and their usage.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer

      The ID of the role, used when setting a role on a persons profile

    • name string

      The name of this role

    • usage integer

      The count of active members that have this role
GET /roles/list 
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/roles/list' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 45,
    "name": "Senior Team Leader",
    "usage": 6
  }
]