Loading ...

REST API: Get Space Directories | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Files » REST API: Get Space Directories
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 34

REST API: Get Space Directories

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

Enables administrators and developers to programmatically retrieve a list of directories based on the space ID and parent directory ID.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
ParentDirectoryIDIntegerYESPathID of the parent directory whose child directories are returned; 0 for the space's top level. For a directory synced from an external drive the space is read as 0.
SpaceIDIntegerYESPathID of the space whose directories are to be returned

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/235/file/directories/336

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "DirectoryID": 3599,
      "DirectoryName": "API Validate matrix dir 620a",
      "ParentID": 3590,
      "UserID": 630,
      "SpaceID": 313,
      "MediaServerID": 0,
      "IsDeleted": false,
      "IsRenamable": true,
      "IsDeletable": true,
      "IsSubDirectoryCreatable": true,
      "CanCreateFile": true,
      "IsSync": false,
      "IsActivityStreamDirectory": false,
      "IsDownloadable": true,
      "ExternalDirectoryType": 0,
      "ExternalURL": "",
      "CreatedByUserType": -1,
      "UpdatedByUserType": -1,
      "DateCreated": "2026-09-05T05:05:39.823",
      "ExternalDirectoryID": "",
      "IsExternalContent": false,
      "IsBeingAddedViaExternalSource": false,
      "FileDirectoryURL": "/spaces/313/api-validate-sandbox/files?directoryID=3599",
      "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. (spaceID, parentDirectoryID)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.
404 Not FoundParentDirectoryID is greater than 0 and no directory has that ID; the response has no body.Verify the ParentDirectoryID.
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