GET v1/assets/folder/{folderId}?depth={depth}&includeFiles={includeFiles}&sort={sort}

Use this method to retrieve a folder structure (excluding files within that folder) up to any level deep.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
folderId

A string containing a UUID which is the unique folder identifier

 string

Required
depth

Optional parameter with the number of folders within the structure to return, use -1 to lookup the entire tree. Default is 0.

 integer

Default value is 0
includeFiles

Optional parameter to indicate if files should be included in the result.

 boolean

Default value is False
sort

Optional sorting direction, this can be Ascending, Descending, or default, default value is Default. Default is treated as, in the order records were created.

 SortOption

Default value is Default

Body Parameters

None.

Response Information

Resource Description

Returns the full directory structure within the folder specified excluding file information.

FolderAssetModel
NameDescriptionTypeAdditional information
name

Folder Name, the maximum size of this field is 200 characters, and special characters are allowed.

 string

None.
parent

Only the root folder has no parent. When updating a folder, living this field empty will simply ignore it, but if the field is different than its original value, the folder will be moved to its new parent.

 string

None.
id

Folder unique identifier.

 string

None.
files

List of child files, note that this property can not be updated through the Folders API, Updates must be initiated using the files API

 Collection of FileAssetModel

None.
notes

Use this property to save notes for this folder. The amount of text associated is virtually unlimited, just remember that the more data, the heavier operations become.

 string

None.
tags

List of tags, currently only saving / retrieving tags are functional but tags are not included within searching functionality.

 Collection of string

None.
folders

Contains a list of sub folders, this property is read-only, operations on this property will not be saved when updating folders. User the regular API for folder update to update any sub folder in its own context.

 Collection of FolderAssetModel

None.
modified

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "parent": "sample string 2",
  "id": "sample string 3",
  "files": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "type": {
        "typeId": "sample string 1",
        "type": "sample string 3"
      },
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "size": "sample string 4",
      "url": "sample string 5",
      "modified": "2025-12-12T21:27:10.0023815-08:00",
      "folder": "sample string 7",
      "notes": "sample string 9",
      "dimensions": "sample string 10"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "type": {
        "typeId": "sample string 1",
        "type": "sample string 3"
      },
      "tags": [
        "sample string 1",
        "sample string 2"
      ],
      "size": "sample string 4",
      "url": "sample string 5",
      "modified": "2025-12-12T21:27:10.0023815-08:00",
      "folder": "sample string 7",
      "notes": "sample string 9",
      "dimensions": "sample string 10"
    }
  ],
  "notes": "sample string 4",
  "tags": [
    "sample string 1",
    "sample string 2"
  ],
  "folders": [],
  "modified": "2025-12-12T21:27:10.0023815-08:00"
}