Loading ...

REST API: Get Space Roles | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Space Roles » REST API: Get Space Roles
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 27

REST API: Get Space Roles

0 
 /5
0 (0votes)
Open API Guide
GET/api/spaces/{SpaceID}/roles

Enables administrators and developers to programmatically retrieve all roles for a specific space.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESPathSpace whose roles are returned. 0 returns the site-level roles.

Optional Parameters

ParameterTypeRequiredLocationDescription
RolenameStringNOQueryWhen sent, returns the one role with this name in the space instead of the list.
UserIDIntegerNOQueryReturn only the roles this user holds in the space; with SpaceID 0, the user's site roles. Default: none, every role.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

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

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "RoleID": 1373,
      "UserID": 0,
      "SpaceID": 313,
      "RoleName": "Member",
      "Description": "This role is what most users will have. This role is assigned to every user that registers or is invited to the space. They cannot access the space Control Panel, but they can create content and interact with other users.",
      "RoleAssignSource": 1,
      "TenantID": 0
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required field missing",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestSpaceID in the path is not an integer.Send the space's numeric ID.
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