Get
/GetUserRoles
Allows you to view all user roles available to your API integration.
Security
API Key
Header parameter nameapi_key
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
Roles
Array of object (Role)
See Role Object.
object
Id
integer (int32)
The role's unique identifier
Example78965
Name
string
The name of the role
ExampleStudent
Description
string | null
The description of the role
ExampleThe default role assigned to all accounts.