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

> Retrieve a paginated list of videos.

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

$videoList = Attract::videos()->listVideos();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "video": {},
      "poster": {
        "metaType": "area",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "items": [
          {
            "type": "@apostrophecms/image",
            "_id": "clx8m2k4p0000a1b2c3d4e5f6",
            "metaType": "widget",
            "_image": [],
            "caption": "Example caption",
            "linkTo": "none",
            "_apostrophecms-any-page-type": [],
            "linkHref": "https://acme.example/example",
            "linkHrefTitle": "Example link href title",
            "linkTitle": "Example link title",
            "linkTarget": [],
            "sectionCss": {}
          }
        ]
      },
      "_folder": [
        {}
      ],
      "slug": "example-slug",
      "visibility": "public",
      "scheduledPublish": "Example scheduled publish",
      "scheduledUnpublish": "Example scheduled unpublish",
      "archived": false,
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListVideosController
{
    public function __invoke(): VideoList
    {
        return Attract::videos()->listVideos();
    }
}
```

**2. Add the route**

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

Route::get('/video', ListVideosController::class);
```

**3. Call it**

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

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call videos.listVideos
```

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

```bash Terminal theme={"dark"}
php artisan attract:call videos.listVideosPick fields=title,slug
```

Only the fields you name, for every document across every page: [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Optional parameters
>
> Named arguments, e.g. `listVideos(page: …)`; leave out the optional ones.
>
> **page** `?int`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `?int`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1.
>
> **search** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).
>
> **aposMode** `Enums\\AposMode|string|null`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **slug** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

> [accordion] Returns
>
> A `VideoList` (`Fetchski\AttractCmsLaravel\Data\VideoList`). A page of Video documents. Read its properties (`$videoList->results`): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (`_id` → `id`, `_folder` → `folder`, `_image` → `image` …).
>
> **results** `Collection\<int, Video\>`
>
> **Always sent.** A list of `Video`. This page’s documents; empty past the last page.
>
> **Video (Fetchski\AttractCmsLaravel\Data\Video)**
>
> Video content type
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **video** `array\<string, mixed\>`
>
> **Always sent.** mp4 or webm. For background loops keep it short, muted, and ideally under \~10 MB.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `Enums\\Visibility|string`
>
> **Always sent.** Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **id** `string`
>
> **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **createdAt** `CarbonImmutable`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `CarbonImmutable`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **poster** `?ImageArea`
>
> **Sometimes sent:** `null` when the site leaves it out. An `ImageArea`. Shown while the video loads, and instead of it for reduced-motion visitors. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.
>
> **ImageArea (Fetchski\AttractCmsLaravel\Data\ImageArea)**
>
> Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.
>
> **metaType** `Enums\\AfterContentAreaMetaType|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback.
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The area’s id, set by the site: leave it out when you write one.
>
> **items** `Collection\<int, ImageWidget\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. A list of `ImageWidget`. The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them). At most 1 items.
>
> **ImageWidget (Fetchski\AttractCmsLaravel\Data\ImageWidget)**
>
> A `@apostrophecms/image` widget: its `type` and its own fields. A field left out takes its default.
>
> **type** `Enums\\ImageWidgetType|string`
>
> **Always sent.** The widget’s type: always `@apostrophecms/image`. One of `@apostrophecms/image`; a newer site may send others, so keep a fallback.
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
>
> **metaType** `Enums\\MetaType|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.
>
> **image** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **caption** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Caption.
>
> **linkTo** `Enums\\LinkTo|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Link To... One of `none`, `@apostrophecms/any-page-type`, `_url`; a newer site may send others, so keep a fallback.
>
> **apostrophecmsAnyPageType** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The related `@apostrophecms/any-page-type` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **linkHref** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. apostrophe:linkHrefHelp When set, a URL; empty or null when not.
>
> **linkHrefTitle** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Link Title.
>
> **linkTitle** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. If empty, the title of the related document will be used.
>
> **linkTarget** `Collection\<int, Enums\\LinkTarget|string\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Link Target. Each one of `_blank`.
>
> **sectionCss** `?CustomCSS`
>
> **Sometimes sent:** `null` when the site leaves it out. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot.
>
> **CustomCSS (Fetchski\AttractCmsLaravel\Data\CustomCSS)**
>
> **slots** `array\<string, string\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The CSS typed into each part slot, by slot name.
>
> **css** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The compiled CSS (read only: rebuilt from `slots`).
>
> **mark** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The site’s check mark for `css` (read only).
>
> **fields** `array\<string, mixed\>`
>
> **Always there:** `[]` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **fields** `array\<string, mixed\>`
>
> **Always there:** `[]` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **folder** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. File this item in a media folder — the stored file physically moves to the matching location in storage. The related `video-folder` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **archived** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.
>
> **pages** `int`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `int`
>
> **Always sent.** This page, from 1.

> [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:read` (or a master above it: `content:videos:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:videos:write` (or a master above it). 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.
* **Paging:** one page per call. To walk them all, use `listVideosAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listVideosAll()` takes `listVideos()`’s arguments except `page`. `listVideosPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields.

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

$videos = Attract::videos()->listVideosAll(); // LazyCollection<int, Video>: the next page is fetched as you iterate
```

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

$rows = Attract::videos()->listVideosPick(fields: ['title', 'slug']); // LazyCollection of ['id' => …, 'title' => …, 'slug' => …]: every video, across every page
```

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListVideosTest extends TestCase
{
    public function test_list_videos(): void
    {
        Attract::fake();

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

        Attract::assertCalled('videos.listVideos');
    }
}
```

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

**Answer with your own values:** fake `videos.listVideos` with a `sequence()` of pages, each `VideoList::factory()->make([...])`, and walk `listVideosAll()`.

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListVideosAnswerTest extends TestCase
{
    public function test_list_videos_answers_your_values(): void
    {
        Attract::fake([
            'videos.listVideos' => Attract::sequence(
                VideoList::factory()->make(['currentPage' => 1, 'pages' => 2]),
                VideoList::factory()->make(['currentPage' => 2, 'pages' => 2]),
            ),
        ]);

        $videos = Attract::videos()->listVideosAll();

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

To fake `listVideosAll()`, answer `videos.listVideos` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List a video’s locales](https://docs.fetchski-attract.com/laravel/reference/videos/get-video-locales.md)
>
> `Attract::videos()->getVideoLocales()`

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

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

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

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

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

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