Loading ...

REST API: Get Space | Axero Documentation

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

REST API: Get Space

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

Get a space's details. SpaceID 0 returns the top level community.

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
ShowBasicInfoIfNoPermissionBooleanNOQuerySet it to true if you want to fetch basic information of a space, when user does not have permission to view that space. To enable this feature, a system property named "ShowPrivateSpaceJoinPage" has to be true.

Optional Parameters

ParameterTypeRequiredLocationDescription
LogViewBooleanNOQueryLogs the API call as an action in User Activity when set to true

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/187?ShowBasicInfoIfNoPermission=true

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": 13,
    "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": "https://your-site.com/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,
    "ManageSpaceURL": "https://your-site.com/spaces/313/api-validate-sandbox/manage/default",
    "SpaceVisibilityText": "Private Space",
    "HasManageSpacePerm": true,
    "AutoSubscribeForums": false,
    "EnableCalendarImportFromExternalSources": false,
    "EnableEventsFromOtherSpacesInCalendar": false,
    "EnableContentExpiration": false,
    "EnableTaskRating": false,
    "ActivityURL": "https://your-site.com/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,
    "DateUpdated": "2026-09-05T05:03:47.19",
    "LatestUserIDUpdated": 630,
    "SpaceNameUnProcessed": "API Validate Sandbox",
    "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 RequestSpaceID in the path is not an integer.Send the space's numeric ID.
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.
200 with ResponseData nullNo space has that ID, or the caller cannot view it and ShowBasicInfoIfNoPermission is off.Check the SpaceID, or send ShowBasicInfoIfNoPermission=true.
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