Loading ...

REST API: Get Roles | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: User Roles » REST API: Get Roles
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 32

REST API: Get Roles

0 
 /5
0 (0votes)
Open API Guide
GET/api/roles

Enables administrators and developers to programmatically retrieve all top level roles.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/roles

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "RoleID": 3,
      "UserID": 0,
      "SpaceID": 0,
      "RoleName": "Member",
      "Description": "Registered members of the website",
      "RoleImageFileName": null
    },
    {
      "RoleID": 2,
      "UserID": 0,
      "SpaceID": 0,
      "RoleName": "Moderator",
      "Description": "Moderator role (default permissions are mostly the same as system administrator)",
      "RoleImageFileName": null
    },
    {
      "RoleID": 6,
      "UserID": 0,
      "SpaceID": 0,
      "RoleName": "Quality Analyst",
      "Description": "Software quality analyst",
      "RoleImageFileName": null
    },
    {
      "RoleID": 1,
      "UserID": 0,
      "SpaceID": 0,
      "RoleName": "SiteAdministrator",
      "Description": "Global Administration role",
      "RoleImageFileName": null
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (roleName)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages