Loading ...

REST API: Get Space Role | Axero Documentation

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

REST API: Get Space Role

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

Get a space role.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESPathUnique identifier for a particular space
RoleIDIntegerYESPathUnique identifier for a particular role

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

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

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "RoleID": 5,
    "UserID": 376,
    "SpaceID": 252,
    "RoleName": "Qualtiy Analyst",
    "Description": "A software quality analystis responsible for applying the principles and practices of software quality assurance."
  }
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestSpaceID or RoleID in the path is not an integer.Send numeric IDs in the path.
401 UnauthorizedMissing or invalid Bearer tokenCheck token validity Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissionsConfirm the user has the required roles for this action
200 with an empty roleSpaceID or RoleID is 0 (an empty role object is returned), or no role has that ID (ResponseData null).Check both IDs.
500 Server ErrorInternal failureRetry 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