Loading ...

REST API: Get Space Root Directory | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Files » REST API: Get Space Root Directory
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 25

REST API: Get Space Root Directory

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

Enables administrators and developers to programmatically retrieve the root directory of a particular space.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESPathUnique ID of the space

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/252/files/directories/root

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "DirectoryID": 3590,
    "DirectoryName": "Root",
    "ParentID": 0,
    "UserID": 630,
    "SpaceID": 313,
    "SpaceName": "API Validate Sandbox",
    "MediaServerID": 0,
    "MediaServerRootURL": "https://your-site.com/Assets/Uploaded-Files",
    "IsDeleted": false,
    "IsRenamable": false,
    "IsDeletable": false,
    "IsSubDirectoryCreatable": false,
    "CanCreateFile": false,
    "IsSync": false,
    "IsActivityStreamDirectory": false,
    "IsDownloadable": false,
    "ExternalDirectoryType": 0,
    "ExternalURL": "",
    "CreatedByUserType": -1,
    "UpdatedByUserType": -1,
    "DateCreated": "2026-09-05T04:01:39.21",
    "ExternalDirectoryID": "",
    "IsExternalContent": false,
    "IsBeingAddedViaExternalSource": 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 nullThe space has no root directory, or no space has that ID.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