Loading ...

REST API: Get All Spaces | Axero Documentation

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

REST API: Get All Spaces

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

Browse the entire directory of public Spaces. This helps users discover new teams, projects, or interest groups they might want to join. Use this to power a search-and-join experience for your community members.

Request

Request Header

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

Optional Parameters

ParameterTypeRequiredLocationDescription
StatusIntegerNOQueryStatus of the spaces to return: PendingWorkflow = 0, Published = 1, Declined = 3, All = 7. Default: 1 (Published); a value that is not a number is read as 1.
VisibilityIntegerNOQuerySpecifies the visibility of the spaces to be returned. All spaces are returned by default. Private = 0, Public = 1, All = 2.
GetNonMemberPublicSpacesOnlyBooleanNOQueryIf true, only the spaces you're a member of and public spaces are returned. If false, all spaces are returned. True by default.
IsMobileBooleanNOQuerySet to true to return a mobile-optimized response format
AddTopLevelCommunityBooleanNOQuerySet to true to include the top-level community as the first item in the response
TruncateLimitIntegerNOQueryMaximum number of characters to include in space descriptions. Set to 0 for no truncation.
GetAllSpacesBooleanNOQuerySet to true to return all spaces regardless of membership or visibility filters

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

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

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SpaceID": 313,
      "ParentSpaceID": 0,
      "IsFeatured": false,
      "Stub": "api-validate-sandbox",
      "TotalMembers": 1,
      "CreatedBy": 630,
      "UserID": 630,
      "SpaceName": "API Validate Sandbox",
      "Description": "Scratch space for /api-validate runs. Everything in here is created and removed by the workflow; see Support\\Documentation\\API Documentationapi-validate-fixtures.json.",
      "UserName": "jane.doe",
      "UserFirstName": "Jane",
      "UserLastName": "Doe",
      "UserEmail": "jane.doe@example.com",
      "StatusID": 1,
      "MembershipType": 0,
      "SpaceVisibility": 0,
      "DateCreated": "2026-09-05T04:01:35.43",
      "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": false,
      "EnableJobs": false,
      "EnableSurveys": false,
      "EnablePhotos": false,
      "EnableTaskManager": false,
      "EnableFiles": false,
      "EnableWiki": false,
      "EnableEvents": false,
      "EnableArticles": false,
      "EnableBlogs": false,
      "EnableVideos": false,
      "EnableIssueTracker": false,
      "EnableFileControl": false,
      "GroupPictureFileName": "",
      "SpaceIconFileName": "",
      "SpaceIconURL": "https://your-site.com/assets/Themes/default/images/space-default.png",
      "MediaServerID": 90,
      "SpaceMediaServerRootURL": "https://your-site.com/Assets/Uploaded-CMS-Files",
      "UserMediaServerRootURL": "https://your-site.com/Assets/Uploaded-Photos",
      "SpaceURL": "/spaces/313/api-validate-sandbox",
      "UserAvatarFileName": "3c002416-1364-4228-b815-9019d520aded.jpg",
      "UpdatedByUserID": 0,
      "InvitationExpiryInDays": 0,
      "DisableWallEmailNotifications": false,
      "AutoSubscribeEmail": true,
      "SpaceImageURL": "https://your-site.com/assets/Themes/default/images/space-default.png",
      "IsArticleCommentWorkflowActive": false,
      "IsBlogEntryCommentWorkflowActive": false,
      "IsEventCommentWorkflowActive": false,
      "IsForumPostWorkflowActive": false,
      "IsPhotoCommentWorkflowActive": false,
      "IsVideoCommentWorkflowActive": false,
      "IsWikiCommentWorkflowActive": false,
      "IsFileCommentWorkflowActive": false,
      "IsIdeaCommentWorkflowActive": false,
      "IsJobCommentWorkflowActive": false,
      "EnableUpcomingBirthdaysControl": false,
      "EnableContentReadConfirmation": false,
      "HasManageSpacePerm": false,
      "AutoSubscribeForums": false,
      "EnableCalendarImportFromExternalSources": false,
      "EnableEventsFromOtherSpacesInCalendar": false,
      "EnableContentExpiration": false,
      "EnableTaskRating": false,
      "ActivityURL": "/spaces/313/api-validate-sandbox",
      "NewContentCount": 0,
      "DescriptionUnProcessed": "Scratch space for /api-validate runs. Everything in here is created and removed by the workflow; see Support\\Documentation\\API Documentationapi-validate-fixtures.json.",
      "SyncAChannelInChat": false,
      "RecursivelyPublic": false,
      "TenantID": 0
    }
  ]
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid.Verify the request payload against the required parameters.
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