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 39

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

Optional Parameters

ParameterTypeRequiredLocationDescription
ShowBasicInfoIfNoPermissionBooleanNOQuerySet to true to return a space's basic information when the caller does not have permission to view the space. This works only when the system property named "ShowPrivateSpaceJoinPage" is true.
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": "marketing",
    "TotalMembers": 2,
    "CreatedBy": 630,
    "UserID": 630,
    "SpaceName": "Marketing",
    "Description": "Campaign planning and shared assets for the marketing team.",
    "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": "https://your-site.com/spaces/313/marketing",
    "UserAvatarFileName": "avatar.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/marketing/manage/default",
    "SpaceVisibilityText": "Private Space",
    "HasManageSpacePerm": true,
    "AutoSubscribeForums": false,
    "EnableCalendarImportFromExternalSources": false,
    "EnableEventsFromOtherSpacesInCalendar": false,
    "EnableContentExpiration": false,
    "EnableTaskRating": false,
    "ActivityURL": "https://your-site.com/spaces/313/marketing",
    "NewContentCount": 5,
    "DescriptionUnProcessed": "Campaign planning and shared assets for the marketing team.",
    "SyncAChannelInChat": false,
    "DateUpdated": "2026-09-05T05:03:47.19",
    "LatestUserIDUpdated": 630,
    "SpaceNameUnProcessed": "Marketing",
    "RecursivelyPublic": false,
    "TenantID": 0
  }
}

Error Response

{
  "Message": "The request is invalid."
}

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 on a site that only members can access. On a site open to guests, the call runs as a guest instead.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions. The caller must hold the Read permission on that space. For a space whose visibility is Private or Isolated, the caller must also be an accepted member of it. A pending or invited user is refused. A site administrator is allowed either way. A space that is not published is refused to everyone else.Confirm the caller holds Read on the space, and is an accepted member when the space is Private or Isolated.
200 with ResponseData nullNo space has that ID: IsError is false and ResponseMessage is Content not found. A caller who cannot view an existing space gets 403 instead, unless ShowBasicInfoIfNoPermission returns the basic information.Check the SpaceID.
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