Skip to main content
POST
List Directories

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Body

application/json

API request schema for listing directories under a parent

parent_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required

Directory ID

name
string
required

Directory name

color
string
required

Hex color code for the directory icon

project_id
string<uuid>
required

ID of the project this directory belongs to

parent_id
string<uuid>
required

ID of the parent resource (directory or project)

created_by_user_id
string<uuid>
required

ID of the user that created the directory

created
string<date-time>
required

Creation timestamp

updated
string<date-time>
required

Last update timestamp

content_modified_at
string<date-time>
required

Filesystem mtime: advances when a direct child is created, deleted, renamed, or moved in or out

True when this item is a projected symlink

target_path
string[] | null

Symlink target path components

target_path_type
enum<string> | null

Symlink target path type

Available options:
relative,
internal_absolute,
external_absolute
target_resource_id
string<uuid> | null

Resolved target resource ID

target_resource_name
string | null

Resolved target resource name

target_resource_type
enum<string> | null

Resolved or hinted target resource type

Available options:
workspace,
project,
directory,
asset,
symlink,
collection,
canvas
target_resolution_status
enum<string> | null

Symlink resolution status

Available options:
resolved,
dangling,
permission_denied,
external
actions
integer | null

User's permission bitmap on this directory

system_kind
enum<string> | null

System-folder marker: 'system_root' for the project's system directory, 'canvas_root' for a folder backing a live canvas, null for a normal directory

Available options:
system_root,
canvas_root
client_performed_at
string<date-time> | null

Server-recorded timestamp of the latest user action on this directory. NULL when no revision exists.