Skip to content

List Folders Tier 2

GET/api/projects/:id/foldersCopied!

Returns every folder in a project as a flat list. Folders are grouped by parent folder ID, root folders come last, and folders in the same group follow their folder order. Build the tree from each folder's parent.

Example

ts
const folders = await client.folders.list("bdbff5de-96d7-468f-9db0-85fe28bd6b62");
bash
youvico folder list --project bdbff5de-96d7-468f-9db0-85fe28bd6b62
bash
curl 'https://api.youvico.com/api/projects/bdbff5de-96d7-468f-9db0-85fe28bd6b62/folders' \
  -H 'Authorization: Bearer YOUR_API_KEY'
json
{
  "data": [
    {
      "id": "DX1234567890ABCD",
      "name": "Renders",
      "parent": null
    }
  ]
}

Request

Path

idstringrequired
Project ID

Response

Returns 200 OK.

dataarray
Folders
data[].idstring
Folder ID

Example: DX1234567890ABCD

data[].namestring
Folder name

Example: Renders

data[].parentobject?
Parent folder. Null for a root folder
data[].parent.idstring
Parent folder ID