> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the video folder tree

> Every video folder, nested, with how many files each holds directly: what the Media manager’s folder rail shows.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$folderTree = Attract::videoFolders()->getVideoFolderTree();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}
```

## In your app

A controller answers a route on your app: it calls `getVideoFolderTree()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/GetVideoFolderTreeController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\FolderTree;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class GetVideoFolderTreeController
{
    public function __invoke(): FolderTree
    {
        return Attract::videoFolders()->getVideoFolderTree();
    }
}
```

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\GetVideoFolderTreeController;
use Illuminate\Support\Facades\Route;

Route::get('/video-folder/tree', GetVideoFolderTreeController::class);
```

Register it before `Route::get('/video-folder/{id}', …)`: Laravel takes the first route that matches, and that one matches this URL too.

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/video-folder/tree
```

With `php artisan serve` running, it prints its answer as JSON.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/GetVideoFolderTree.php` (an invokable Action that calls `getVideoFolderTree()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action videoFolders.getVideoFolderTree
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call videoFolders.getVideoFolderTree
```

It calls `getVideoFolderTree()` on your default site and prints its answer as JSON. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

For someone who may edit the video library (and the management key); everyone else gets 404.

> [accordion] Parameters
>
> None: call it with no arguments.

> [accordion] Returns
>
> A `FolderTree` (`Fetchski\AttractCmsLaravel\Data\FolderTree`). The folder tree: the root folders by title, each with its subfolders. Read its properties (`$folderTree->results`): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (`_id` → `id`).
>
> **results** `Collection\<int, FolderTreeNode\>`
>
> **Always sent.** A list of `FolderTreeNode`.
>
> **FolderTreeNode (Fetchski\AttractCmsLaravel\Data\FolderTreeNode)**
>
> A folder, with its subfolders. Every field is always sent.
>
> **id** `string`
>
> **Always sent.** The folder’s `aposDocId`.
>
> **title** `string`
>
> **Always sent.**
>
> **folderPath** `string`
>
> **Always sent.** Its path, e.g. `events/summer`.
>
> **level** `int`
>
> **Always sent.** Its depth: 0 at the root.
>
> **parentId** `?string`
>
> **Always sent, can be `null`.** Its parent folder’s `_id`; null at the root.
>
> **linkedAlbumId** `?string`
>
> **Always sent, can be `null`.** The photo album it belongs to, if it is an album’s folder.
>
> **linkedFeedId** `?string`
>
> **Always sent, can be `null`.** The photo feed it belongs to, if it is a feed’s folder.
>
> **referenceOnly** `bool`
>
> **Always sent.** Flagged as a reference folder itself (its files are never offered for use).
>
> **reference** `bool`
>
> **Always sent.** Inside a reference tree (itself included).
>
> **count** `int`
>
> **Always sent.** Files directly in it (not in its subfolders).
>
> **children** `Collection\<int, FolderTreeNode\>`
>
> **Always sent.** A list of `FolderTreeNode`. Its fields are listed under the first `FolderTreeNode` above.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors()` lists each field’s problem, `siteMessage()` the first.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage()` names it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason()`, `neverConnected()`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason()` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason()`, `status()`.
>
> **UnknownSite** `setup`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (what to fix).

## Behavior

* **Access:** an API key with `content:videos:write` (or a master above it: `content:videos:all`, `content:all`, `admin:all`). A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` in `config/fetchski-attract.php` for longer.

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/GetVideoFolderTreeTest.php`, then run your tests:

```php tests/Feature/GetVideoFolderTreeTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetVideoFolderTreeTest extends TestCase
{
    public function test_get_video_folder_tree(): void
    {
        Attract::fake();

        $this->getJson('/video-folder/tree')->assertOk();

        Attract::assertCalled('videoFolders.getVideoFolderTree');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

## Related

> [card] [List video folders](https://docs.fetchski-attract.com/laravel/reference/video-folders/list-video-folders.md)
>
> `Attract::videoFolders()->listVideoFolders()`

> [card] [Create a video folder](https://docs.fetchski-attract.com/laravel/reference/video-folders/create-video-folder.md)
>
> `Attract::videoFolders()->createVideoFolder()`

> [card] [Get a video folder](https://docs.fetchski-attract.com/laravel/reference/video-folders/get-video-folder.md)
>
> `Attract::videoFolders()->getVideoFolder()`

> [card] [Replace a video folder](https://docs.fetchski-attract.com/laravel/reference/video-folders/replace-video-folder.md)
>
> `Attract::videoFolders()->replaceVideoFolder()`

> [card] [Delete a video folder](https://docs.fetchski-attract.com/laravel/reference/video-folders/delete-video-folder.md)
>
> `Attract::videoFolders()->deleteVideoFolder()`

> [card] [Update a video folder](https://docs.fetchski-attract.com/laravel/reference/video-folders/update-video-folder.md)
>
> `Attract::videoFolders()->updateVideoFolder()`

> [card] [GET /video-folder/tree](https://docs.fetchski-attract.com/api-reference/video-folders/get-the-video-folder-tree.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.