Loading ...

REST API: Get Child Spaces | Axero Documentation

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

REST API: Get Child Spaces

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

Finds all the spaces created under the parent space.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
ParentSpaceIDIntegerYESQueryID of the parent space whose child spaces are to be returned
UserIDIntegerYESQueryID of the user whose child spaces are returned. Send an empty value for no user filter; the parameter itself must be present.
FromCacheBooleanYESQuerySpecifies if the results are to be returned from cache. Values: true or false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/child?parentSpaceID=1&userID=376&fromCache=false

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SpaceID": 252,
      "ParentSpaceID": 208,
      "IsFeatured": false,
      "Stub": null,
      "LandingPage": null,
      "TotalMembers": 10,
      "CreatedBy": 1,
      "UserID": 376,
      "SpaceName": "Fish",
      "Author": null,
      "Description": "A fish is any member of a paraphyletic group of organisms that consist of all gill-bearing aquatic craniate animals that lack limbs with digits.",
      "UserName": "jhon",
      "UserFirstName": "John",
      "UserLastName": "Smith",
      "UserEmail": "SampleEmail@your-site.com",
      "StatusID": 1,
      "MembershipType": 0,
      "SpaceVisibility": 1,
      "DateCreated": "2026-01-01T12:00:00Z",
      "WorkFlowID": 0,
      "CurrentWorkFlowStepID": 0,
      "IsArticleWorkflowActive": false,
      "IsBlogWorkflowActive": false,
      "IsEventWorkflowActive": false,
      "IsForumWorkflowActive": false,
      "IsWikiWorkflowActive": false,
      "IsFileWorkflowActive": false,
      "IsPhotoWorkFlowActive": false,
      "IsVideoWorkFlowActive": false,
      "EnableForums": false,
      "EnableSurveys": false,
      "EnablePhotos": false,
      "EnableTaskManager": false,
      "EnableFiles": false,
      "EnableWiki": false,
      "EnableEvents": false,
      "EnableArticles": false,
      "EnableBlogs": false,
      "EnableVideos": false,
      "EnableIssueTracker": false,
      "EnableFileControl": false,
      "GroupPictureFileName": null,
      "SpaceIconFileName": null,
      "SpaceIconURL": null,
      "MediaServerID": 0,
      "SpaceMediaServerRootURL": null,
      "UserMediaServerRootURL": null,
      "SpaceURL": null,
      "UpdatedByUserID": 0,
      "InvitationExpiryInDays": 0,
      "DisableWallEmailNotifications": false,
      "AutoSubscribeEmail": false,
      "Image": null,
      "SpaceImageURL": null,
      "IsArticleCommentWorkflowActive": false,
      "IsBlogEntryCommentWorkflowActive": false,
      "IsEventCommentWorkflowActive": false,
      "IsForumPostWorkflowActive": false,
      "IsPhotoCommentWorkflowActive": false,
      "IsVideoCommentWorkflowActive": false,
      "IsWikiCommentWorkflowActive": false,
      "IsFileCommentWorkflowActive": false,
      "IsIdeaCommentWorkflowActive": false,
      "SpaceHeaderImageFileName": null,
      "EnableUpcomingBirthdaysControl": false,
      "EnableContentReadConfirmation": false
    }
  ]
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (parentSpaceID, userID, fromCache)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