> ## 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.

# List videos

> The videos in the library, most recently updated first, a page at a time.

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

$listMediaVideos = Attract::fetchskiMedia()->listMediaVideos();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListMediaVideosController
{
    public function __invoke(): ListMediaVideosResponse
    {
        return Attract::fetchskiMedia()->listMediaVideos();
    }
}
```

**2. Add the route**

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

Route::get('/fetchski-media/videos', ListMediaVideosController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/fetchski-media/videos
```

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/ListMediaVideos.php` (an invokable Action that calls `listMediaVideos()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action fetchskiMedia.listMediaVideos
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call fetchskiMedia.listMediaVideos
```

It calls `listMediaVideos()` 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.

Use a video’s slug to reference it in an MDX blog import.

> [accordion] Optional parameters
>
> Named arguments, e.g. `listMediaVideos(q: …)`; leave out the optional ones.
>
> **q** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Words matched against each video’s title, alt text and other text: any of the words matches, best match first.
>
> **folder** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. A media folder ID: only what is in that folder.
>
> **includeSubfolders** `?bool`
>
> **Optional.** Leave it out and the site uses `true`. With `folder`: include its subfolders too.
>
> **limit** `?int`
>
> **Optional.** Leave it out and the site uses `25`. Items per page: 1 to 100, 25 when left out (a value outside is brought into that range, never refused).
>
> **page** `?int`
>
> **Optional.** Leave it out and the site uses `1`. Page number, from 1.

> [accordion] Returns
>
> A `ListMediaVideosResponse` (`Fetchski\AttractCmsLaravel\Data\ListMediaVideosResponse`). A page of videos. Read its properties (`$listMediaVideos->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, MediaVideo\>`
>
> **Always sent.** A list of `MediaVideo`.
>
> **MediaVideo (Fetchski\AttractCmsLaravel\Data\MediaVideo)**
>
> One video from the Videos library.
>
> **id** `?string`
>
> **Always sent, can be `null`.** The video’s document ID (aposDocId).
>
> **slug** `?string`
>
> **Always sent, can be `null`.** Reference a video in an MDX import by it.
>
> **title** `?string`
>
> **Always sent, can be `null`.** Its title.
>
> **folderPath** `?string`
>
> **Always sent, can be `null`.** The media folder it sits in.
>
> **extension** `?string`
>
> **Always sent, can be `null`.** File extension, e.g. `mp4`.
>
> **bytes** `?int`
>
> **Always sent, can be `null`.** Size of the file.
>
> **url** `?string`
>
> **Always sent, can be `null`.** The video file.
>
> **poster** `?string`
>
> **Always sent, can be `null`.** The poster image, when one is set.
>
> **page** `int`
>
> **Always sent.**
>
> **perPage** `int`
>
> **Always sent.**
>
> **total** `int`
>
> **Always sent.** Every match, across all pages.

> [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)).
>
> **AuthenticationFailed** `401`
>
> The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **Forbidden** `403`
>
> The API key lacks the scope this route needs, is used from outside its allowlist, or the caller is anonymous.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **RateLimited** `429`
>
> The key used up its reads-per-minute limit. Still, after the client’s own waits and retries.
>
> **Retried first:** Yes: the client waits `Retry-After` (1 s when absent; over 60 s it gives up at once) and retries, up to `retries` times (2 by default). **Read:** `retryAfter()` (seconds, or null), `siteMessage()`.
>
> **SiteError** `5xx`
>
> The site failed (or something in front of it did). Its logs say why.
>
> **Retried first:** A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. **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 `videos:read` — or `media:all`, or `admin:all` — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403.
* **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.
* **Paging:** one page per call. To walk them all, use `listMediaVideosAll()` (see More examples): it asks for the next page as you iterate, and stops once `page` × `perPage` reaches `total`.

## More examples

`listMediaVideosAll()` takes `listMediaVideos()`’s arguments except `page`.

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

$mediaVideos = Attract::fetchskiMedia()->listMediaVideosAll(); // LazyCollection<int, MediaVideo>: the next page is fetched as you iterate
```

## 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/ListMediaVideosTest.php`, then run your tests:

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListMediaVideosTest extends TestCase
{
    public function test_list_media_videos(): void
    {
        Attract::fake();

        $this->getJson('/fetchski-media/videos')->assertOk();

        Attract::assertCalled('fetchskiMedia.listMediaVideos');
    }
}
```

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

**Answer with your own values:** fake `fetchskiMedia.listMediaVideos` with a `sequence()` of pages, each `ListMediaVideosResponse::factory()->make([...])`, and walk `listMediaVideosAll()`.

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListMediaVideosAnswerTest extends TestCase
{
    public function test_list_media_videos_answers_your_values(): void
    {
        Attract::fake([
            'fetchskiMedia.listMediaVideos' => Attract::sequence(
                ListMediaVideosResponse::factory()->make(['page' => 1, 'perPage' => 1, 'total' => 2]),
                ListMediaVideosResponse::factory()->make(['page' => 2, 'perPage' => 1, 'total' => 2]),
            ),
        ]);

        $mediaVideos = Attract::fetchskiMedia()->listMediaVideosAll();

        $this->assertCount(2, $mediaVideos->all());
    }
}
```

To fake `listMediaVideosAll()`, answer `fetchskiMedia.listMediaVideos` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List images](https://docs.fetchski-attract.com/laravel/reference/fetchski-media/list-media-images.md)
>
> `Attract::fetchskiMedia()->listMediaImages()`

> [card] [Get one image](https://docs.fetchski-attract.com/laravel/reference/fetchski-media/get-media-image.md)
>
> `Attract::fetchskiMedia()->getMediaImage()`

> [card] [Get one video](https://docs.fetchski-attract.com/laravel/reference/fetchski-media/get-media-video.md)
>
> `Attract::fetchskiMedia()->getMediaVideo()`

> [card] [GET /fetchski-media/videos](https://docs.fetchski-attract.com/api-reference/fetchski-media/list-videos.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.