Loading ...

REST API: Get User Spaces | Axero Documentation

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

REST API: Get User Spaces

0 
 /5
0 (0votes)
Open API Guide
GET/api/spaces/me

Lists the published spaces the calling user belongs to. The list is empty when spaces are switched off. This page and Get My Spaces document the same operation on the same route. Both return the spaces of the user the token belongs to. To read another user's spaces, use Get User Space IDs, which is the per-user route.

Request

Request Header

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

Optional Parameters

ParameterTypeRequiredLocationDescription
AddTopLevelCommunityBooleanNOQuerySet to true to include the top level community (SpaceID 0) in the list. Default: false. A value that is not true or false is read as false.
SetHasManageSpacePermBooleanNOQuerySet to true to include, on each space, whether the calling user can manage it. The same setting also returns ManageSpaceURL as an absolute URL and rewrites every image src in each space's Description to an absolute URL. Default: false. A value that is not true or false is read as false.
IsMobileBooleanNOQuerySet to true to return the short list the mobile app uses. Each space then carries only SpaceID, SpaceName, SpaceIconURL, and SpaceVisibilityText, and SetHasManageSpacePerm is ignored. Default: false. A value that is not true or false is read as false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/me

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SpaceURL": "https://your-site.com/252/human-resources/hr-homepage",
      "SpaceName": "Human Resources",
      "SpaceImageURL": "https://your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/931d24b3-e669-4151-ab2c-3159775730c7.jpg"
    }
  ]
}

Error Response

You do not have sufficient permissions to perform this action.

Error Handling

Status CodeLikely CauseNext Action
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned by this endpoint, which makes no permission check of its own.No action needed.
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