Loading ...

REST API: Get User Space Roles | Axero Documentation

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

REST API: Get User Space Roles

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

Get the space roles a user holds in a space.

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
UserIDIntegerYESQueryUser whose roles in the space are returned. Sending it is what narrows the list: without it every role in the space is returned (see Get Space Roles), which is why a request without it answers 200. With SpaceID 0, the user's site-level roles are returned.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/78/roles?userid=90

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "RoleID": 980,
      "UserID": 90,
      "SpaceID": 78,
      "RoleName": "Member",
      "Description": "Community members who have joined the space, with normal permissions.",
      "RoleImageFileName": null
    }
  ]
}

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, or UserID is not an integer.Send numeric IDs.
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