Loading ...

REST API: Get My Spaces | Axero Documentation

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

REST API: Get My Spaces

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

Enables administrators and developers to programmatically retrieve a list of the logged in user's spaces.

Request

Request Header

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

Optional Parameters

ParameterTypeRequiredLocationDescription

Optional Parameters

ParameterTypeRequiredLocationDescription
AddTopLevelCommunityBooleanNOQuerySet to true to include the top level community (SpaceID 0) in the list. Default: false.
SetHasManageSpacePermBooleanNOQuerySet to true to include, on each space, whether the calling user can manage it. Default: false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

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

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SpaceURL": "your-site.com/spaces/252/human-resources/hr-homepage",
      "SpaceName": "Human Resources",
      "SpaceImageURL": "your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/46283b79-6c58-4f71-8e13-e1414b688dd5.png",
      "Description": "A space dedicated to all your human resources needs and questions.",
      "SpaceID": 252,
      "ParentSpaceID": 0,
      "IsFeatured": false,
      "Stub": "human-resources",
      "LandingPage": "your-site.com/spaces/252/human-resources/hr-homepage",
      "TotalMembers": 102,
      "CreatedBy": 376,
      "UserID": 376,
      "UserName": "admin",
      "UserFirstName": "Alexis",
      "UserLastName": "Fox",
      "UserEmail": "admin@your-site.com",
      "StatusID": 1,
      "MembershipType": 1,
      "SpaceVisibility": 1,
      "DateCreated": "2026-01-01T12:00:00Z",
      "IsAttendee": false,
      "EventID": 0,
      "InviteSpaceID": 0,
      "WorkFlowID": 0,
      "CurrentWorkFlowStepID": 0,
      "IsArticleWorkflowActive": true,
      "IsBlogWorkflowActive": false,
      "IsEventWorkflowActive": false,
      "IsForumWorkflowActive": false,
      "IsWikiWorkflowActive": false,
      "IsFileWorkflowActive": false,
      "IsPhotoWorkFlowActive": false,
      "IsJobWorkflowActive": false,
      "IsVideoWorkFlowActive": false,
      "EnableForums": true,
      "EnableJobs": false,
      "EnableSurveys": true,
      "EnablePhotos": true,
      "EnableTaskManager": true,
      "EnableFiles": true,
      "EnableWiki": true,
      "EnableEvents": true,
      "EnableArticles": true,
      "EnableBlogs": true,
      "EnableVideos": true,
      "EnableIssueTracker": true,
      "EnableFileControl": false,
      "GroupPictureFileName": "46283b79-6c58-4f71-8e13-e1414b688dd5.png",
      "SpaceIconFileName": "46283b79-6c58-4f71-8e13-e1414b688dd5_icon.png",
      "SpaceIconURL": "your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/46283b79-6c58-4f71-8e13-e1414b688dd5_icon.png",
      "MediaServerID": 24,
      "SpaceMediaServerRootURL": "your-site.com/Assets/Uploaded-CMS-Files",
      "UserMediaServerRootURL": "your-site.com/Assets/Uploaded-Photos",
      "UserAvatarFileName": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "UpdatedByUserID": 0,
      "InvitationExpiryInDays": 0,
      "DisableWallEmailNotifications": true,
      "AutoSubscribeEmail": true,
      "IsArticleCommentWorkflowActive": false,
      "IsBlogEntryCommentWorkflowActive": false,
      "IsEventCommentWorkflowActive": false,
      "IsForumPostWorkflowActive": false,
      "IsPhotoCommentWorkflowActive": false,
      "IsVideoCommentWorkflowActive": false,
      "IsWikiCommentWorkflowActive": false,
      "IsFileCommentWorkflowActive": false,
      "IsIdeaCommentWorkflowActive": false,
      "IsJobCommentWorkflowActive": false,
      "EnableUpcomingBirthdaysControl": true,
      "EnableContentReadConfirmation": true,
      "ManageSpaceURL": "your-site.com/spaces/252/human-resources/manage/default",
      "SpaceVisibilityText": "Public Space",
      "HasManageSpacePerm": true,
      "AutoSubscribeForums": true,
      "EnableCalendarImportFromExternalSources": false,
      "EnableEventsFromOtherSpacesInCalendar": true,
      "EnableContentExpiration": true,
      "EnableTaskRating": true,
      "ActivityURL": "your-site.com/spaces/252/human-resources/?act=1",
      "NewContentCount": 56
    },
    {
      "SpaceURL": "your-site.com/spaces/255/internal-communications",
      "SpaceName": "Internal Communications",
      "SpaceImageURL": "your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/255/83816c16-f571-4bd1-a2a5-3c95e1200c5b.png",
      "Description": "The space for accessing all of the company's internal communications.",
      "SpaceID": 252,
      "ParentSpaceID": 0,
      "IsFeatured": false,
      "Stub": "internal-communications",
      "LandingPage": "",
      "TotalMembers": 2,
      "CreatedBy": 376,
      "UserID": 376,
      "UserName": "admin",
      "UserFirstName": "Alexis",
      "UserLastName": "Fox",
      "UserEmail": "admin@your-site.com",
      "StatusID": 1,
      "MembershipType": 1,
      "SpaceVisibility": 1,
      "DateCreated": "2026-01-01T12:00:00Z",
      "IsAttendee": false,
      "EventID": 0,
      "InviteSpaceID": 0,
      "WorkFlowID": 0,
      "CurrentWorkFlowStepID": 0,
      "IsArticleWorkflowActive": false,
      "IsBlogWorkflowActive": false,
      "IsEventWorkflowActive": false,
      "IsForumWorkflowActive": false,
      "IsWikiWorkflowActive": false,
      "IsFileWorkflowActive": false,
      "IsPhotoWorkFlowActive": false,
      "IsJobWorkflowActive": false,
      "IsVideoWorkFlowActive": false,
      "EnableForums": true,
      "EnableJobs": false,
      "EnableSurveys": true,
      "EnablePhotos": true,
      "EnableTaskManager": true,
      "EnableFiles": true,
      "EnableWiki": true,
      "EnableEvents": true,
      "EnableArticles": true,
      "EnableBlogs": true,
      "EnableVideos": true,
      "EnableIssueTracker": true,
      "EnableFileControl": false,
      "GroupPictureFileName": "83816c16-f571-4bd1-a2a5-3c95e1200c5b.png",
      "SpaceIconFileName": "83816c16-f571-4bd1-a2a5-3c95e1200c5b_icon.png",
      "SpaceIconURL": "your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/255/83816c16-f571-4bd1-a2a5-3c95e1200c5b_icon.png",
      "MediaServerID": 24,
      "SpaceMediaServerRootURL": "your-site.com/Assets/Uploaded-CMS-Files",
      "UserMediaServerRootURL": "your-site.com/Assets/Uploaded-Photos",
      "UserAvatarFileName": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "UpdatedByUserID": 0,
      "InvitationExpiryInDays": 0,
      "DisableWallEmailNotifications": false,
      "AutoSubscribeEmail": true,
      "IsArticleCommentWorkflowActive": false,
      "IsBlogEntryCommentWorkflowActive": false,
      "IsEventCommentWorkflowActive": false,
      "IsForumPostWorkflowActive": false,
      "IsPhotoCommentWorkflowActive": false,
      "IsVideoCommentWorkflowActive": false,
      "IsWikiCommentWorkflowActive": false,
      "IsFileCommentWorkflowActive": false,
      "IsIdeaCommentWorkflowActive": false,
      "IsJobCommentWorkflowActive": false,
      "EnableUpcomingBirthdaysControl": false,
      "EnableContentReadConfirmation": true,
      "HasManageSpacePerm": true,
      "AutoSubscribeForums": false,
      "EnableCalendarImportFromExternalSources": false,
      "EnableEventsFromOtherSpacesInCalendar": false,
      "EnableContentExpiration": false,
      "EnableTaskRating": false,
      "ActivityURL": "your-site.com/spaces/255/internal-communications",
      "NewContentCount": 133
    },
    {
      "SpaceURL": "your-site.com/spaces/256/information-technology",
      "SpaceName": "Information Technology",
      "SpaceImageURL": "your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/256/02704bbe-ef30-455a-8f31-3c0a242e6b3a.jpg",
      "Description": "Submit your help desk and tech questions here.",
      "SpaceID": 252,
      "ParentSpaceID": 0,
      "IsFeatured": false,
      "Stub": "information-technology",
      "LandingPage": "",
      "TotalMembers": 2,
      "CreatedBy": 376,
      "UserID": 376,
      "UserName": "admin",
      "UserFirstName": "Alexis",
      "UserLastName": "Fox",
      "UserEmail": "admin@your-site.com",
      "StatusID": 1,
      "MembershipType": 1,
      "SpaceVisibility": 1,
      "DateCreated": "2026-01-01T12:00:00Z",
      "IsAttendee": false,
      "EventID": 0,
      "InviteSpaceID": 0,
      "WorkFlowID": 0,
      "CurrentWorkFlowStepID": 0,
      "IsArticleWorkflowActive": false,
      "IsBlogWorkflowActive": false,
      "IsEventWorkflowActive": false,
      "IsForumWorkflowActive": false,
      "IsWikiWorkflowActive": false,
      "IsFileWorkflowActive": false,
      "IsPhotoWorkFlowActive": false,
      "IsJobWorkflowActive": false,
      "IsVideoWorkFlowActive": false,
      "EnableForums": true,
      "EnableJobs": false,
      "EnableSurveys": true,
      "EnablePhotos": true,
      "EnableTaskManager": true,
      "EnableFiles": true,
      "EnableWiki": true,
      "EnableEvents": true,
      "EnableArticles": true,
      "EnableBlogs": true,
      "EnableVideos": true,
      "EnableIssueTracker": true,
      "EnableFileControl": false,
      "GroupPictureFileName": "02704bbe-ef30-455a-8f31-3c0a242e6b3a.jpg",
      "SpaceIconFileName": "02704bbe-ef30-455a-8f31-3c0a242e6b3a_icon.jpg",
      "SpaceIconURL": "your-site.com/Assets/Uploaded-CMS-Files/SpacesFiles/256/02704bbe-ef30-455a-8f31-3c0a242e6b3a_icon.jpg",
      "MediaServerID": 24,
      "SpaceMediaServerRootURL": "your-site.com/Assets/Uploaded-CMS-Files",
      "UserMediaServerRootURL": "your-site.com/Assets/Uploaded-Photos",
      "UserAvatarFileName": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "UpdatedByUserID": 0,
      "InvitationExpiryInDays": 0,
      "DisableWallEmailNotifications": false,
      "AutoSubscribeEmail": true,
      "IsArticleCommentWorkflowActive": false,
      "IsBlogEntryCommentWorkflowActive": false,
      "IsEventCommentWorkflowActive": false,
      "IsForumPostWorkflowActive": false,
      "IsPhotoCommentWorkflowActive": false,
      "IsVideoCommentWorkflowActive": false,
      "IsWikiCommentWorkflowActive": false,
      "IsFileCommentWorkflowActive": false,
      "IsIdeaCommentWorkflowActive": false,
      "IsJobCommentWorkflowActive": false,
      "EnableUpcomingBirthdaysControl": false,
      "EnableContentReadConfirmation": true,
      "HasManageSpacePerm": true,
      "AutoSubscribeForums": false,
      "EnableCalendarImportFromExternalSources": false,
      "EnableEventsFromOtherSpacesInCalendar": false,
      "EnableContentExpiration": false,
      "EnableTaskRating": false,
      "ActivityURL": "your-site.com/spaces/256/information-technology",
      "NewContentCount": 87
    }
  ]
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
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