Loading ...

REST API: Get Space Files | Axero Documentation

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

REST API: Get Space Files

0 
 /5
0 (0votes)
Open API Guide
GET/api/files/space

Enables administrators and developers to programmatically retrieve a list of files in a space.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESQueryID of the space from which the list of files are to be returned

Optional Parameters

ParameterTypeRequiredLocationDescription
FileDirectoryIDIntegerNOQueryID of the file directory from which list of files are to be returned
StatusIntegerNOQueryStatus of the files to return, an EntityStatus value: PendingWorkflow = 0, Published = 1, Draft = 2, Declined = 3, Updated = 4, Expired = 5, Spam = 6, All = 7, DelayedPublishing = 8, TemporarilySaved = 9, UnderProcessing = 10, Deleted = 11. Default: 7 (All).
SortColumnStringNOQuerySort content based on a column. Here are the values of Sort Column parameter: Unspecified = 0, DateCreated = 1, Rating = 2, DatePublished = 3, DateUpdated = 4, ViewCount = 5, CommentCount = 6, EventStartDate = 7, SortOrder = 8, VoteCount = 9, ContentTitle = 10, DateAwarded = 11, TagCount = 12, MostRelavant = 13.
SortTypeIntegerNOQueryThe order in which content is to be sorted. Here are the values of Sort Type parameter: Ascending = 0, Descending = 1, Unspecified = 2.
StartPageIntegerNOQueryPage of results to return. Default: 1.
PageLengthIntegerNOQueryNumber of results to return per page. When omitted, every matching file is returned in one page.
UserIDIntegerNOQueryReturn only the files uploaded by this user. Omit for every user.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/files/space?SpaceID=234&Status=1&SortColumn=1&SortType=0&StartPage=1&PageLength=100

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ContentID": 2355,
      "EntityType": 14,
      "ContentTypeID": 14,
      "ContentTitle": "star.png",
      "ContentStub": "star-png",
      "ContentBody": "",
      "ContentBodyUnprocessed": "",
      "ContentSummary": "",
      "AuthorID": 1,
      "AuthorUserName": "john",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "John Smith",
      "UpdatedByUserUsername": "john",
      "UpdatedByUserEmail": "acme@acme.com",
      "UpdatedByUserFirstName": "John",
      "UpdatedByUserLastName": "Smith",
      "UpdatedByUserAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
      "UpdatedByUserProfileUrl": "https://your-site.com//people/john",
      "ParentContentID": 326,
      "ContentVersionID": 1,
      "SpaceID": 234,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2026-02-09T12:03:10.557",
      "DatePublished": "2026-02-09T12:03:12.78",
      "DateUpdated": "2026-02-09T12:03:10.557",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0,
      "MetaTitle": "star.png",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentMediaServerID": 3,
      "ContentMediaFileName": "02824a14-39c2-4828-a128-11e4648706b7.png",
      "ContentMediaServerRootURL": "https://your-site.com/Assets/Uploaded-CMS-Files",
      "SpaceName": "Files storage space",
      "SpaceURL": "/spaces/234/files-storage-space",
      "AuthorDisplayName": "John Smith",
      "AuthorEmail": "acme@acme.com",
      "AuthorFirstName": "John",
      "AuthorLastName": "Smith",
      "AuthorAvatarImageUrl": "https://your-site.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
      "AuthorProfileUrl": "http://your-site.com//people/john",
      "IsLatest": false,
      "DateCreatedString": "19 minutes ago",
      "DatePublishedString": "19 minutes ago",
      "DateUpdatedString": "19 minutes ago",
      "ContentURL": "/spaces/234/file-storage-space/files/2355/star-png",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "IsPublishedFromDelayedPublishingMode": false,
      "ParentContentTitle": "Root",
      "ParentContentURL": "/spaces/files/default?spaceid=234&spacename=file-storage-space&directoryid=326",
      "IsPublishedFromUnderProcessingMode": false,
      "IsWallContent": false,
      "ContentFileSize": 159926,
      "ContentFileSizeString": "156.2KB",
      "ContentTypeIconCSSClass": "cf-icon cf-icon-file-image",
      "ContentFileUpdateType": 0,
      "IsEditable": true,
      "IsDeletable": true,
      "IsDownloadable": true,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": true,
      "IsMoveable": true,
      "ContentMediaOnlineViewUrl": "/spaces/234/files-storage-space/files/view/2355",
      "ContentMediaUrl": "/fileattachment?file=tTC%2FraSgl9HKLbDv5%2BOcig%3D%3D&v=1",
      "IsDirectory": false
    }
  ]
}

Error Response

{
  "Message": "The requested resource does not support http method 'GET'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (spaceID)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.
404 or 405A required query parameter was left out, so the request matched a different action or none: the message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter; the message is not about the resource.

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