> ## 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 a folder’s photos

> The published images in a folder, newest first, as a gallery shows them.

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

$listImageFolderPhotos = Attract::imageFolders()->listImageFolderPhotos(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListImageFolderPhotosController
{
    public function __invoke(string $id): ListImageFolderPhotosResponse
    {
        return Attract::imageFolders()->listImageFolderPhotos(id: $id);
    }
}
```

**2. Add the route**

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

Route::get('/image-folder/{id}/photos', ListImageFolderPhotosController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/image-folder/clx8m2k4p0000a1b2c3d4e5f6/photos
```

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call imageFolders.listImageFolderPhotos id=clx8m2k4p0000a1b2c3d4e5f6
```

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

A reference folder (one whose images never feed a gallery) answers 404.

## Find the id

`id` is the document’s `_id`, from a list. Ask the list for only the fields you need: each row is a document’s `id` and those fields.

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

$row = Attract::imageFolders()->listImageFoldersPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

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

Pass `$row['id']` as `id`. See [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Required parameters
>
> Named arguments, e.g. `listImageFolderPhotos(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **Required.** The folder’s document ID.

> [accordion] Optional parameters
>
> **includeSubfolders** `?string`
>
> **Optional.** Leave it out and the site uses `"1"`. Send `0` for this folder only; anything else includes its subfolders.
>
> **max** `?int`
>
> **Optional.** Leave it out and the site uses `200`. At most this many photos. 1 to 200.

> [accordion] Returns
>
> A `ListImageFolderPhotosResponse` (`Fetchski\AttractCmsLaravel\Data\ListImageFolderPhotosResponse`). The folder and its photos. Read its properties (`$listImageFolderPhotos->folder`): 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`, `_urls` → `urls`).
>
> **folder** `ListImageFolderPhotosResponseFolder`
>
> **Always sent.** A `ListImageFolderPhotosResponseFolder`.
>
> **ListImageFolderPhotosResponseFolder (Fetchski\AttractCmsLaravel\Data\ListImageFolderPhotosResponseFolder)**
>
> Required.
>
> **id** `string`
>
> **Always sent.**
>
> **title** `string`
>
> **Always sent.**
>
> **folderPath** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **results** `Collection\<int, GalleryPhoto\>`
>
> **Always sent.** A list of `GalleryPhoto`.
>
> **GalleryPhoto (Fetchski\AttractCmsLaravel\Data\GalleryPhoto)**
>
> **id** `string`
>
> **Always sent.** The image’s document ID.
>
> **attachment** `GalleryPhotoFile`
>
> **Always sent.** A `GalleryPhotoFile`. The image file: its size, and a URL per rendered size.
>
> **GalleryPhotoFile (Fetchski\AttractCmsLaravel\Data\GalleryPhotoFile)**
>
> **id** `string`
>
> **Always sent.**
>
> **name** `string`
>
> **Always sent.** The file name, without its extension.
>
> **extension** `string`
>
> **Always sent.**
>
> **urls** `array\<string, string\>`
>
> **Always sent.** Size name (`max`, `full`, `two-thirds`, `one-half`, `one-third`, `one-sixth`, `original`) → URL.
>
> **width** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **height** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **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.
>
> **title** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **alt** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Alt text; empty when none is set.
>
> **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.

> [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 (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **NotFound** `404`
>
> Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **RateLimited** `429`
>
> The key used up its 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 `images:read`, or `media:all`, or `admin:all`, or any signed-in CMS user. The site’s own server may call it too. Other callers get 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/ListImageFolderPhotosTest.php`, then run your tests:

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListImageFolderPhotosTest extends TestCase
{
    public function test_list_image_folder_photos(): void
    {
        Attract::fake();

        $this->getJson('/image-folder/clx8m2k4p0000a1b2c3d4e5f6/photos')->assertOk();

        Attract::assertCalled('imageFolders.listImageFolderPhotos', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}
```

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

**Answer with your own values:** fake `imageFolders.listImageFolderPhotos` with `ListImageFolderPhotosResponse::factory()->make([...])`, the fields you give over a valid example (nested ones too).

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListImageFolderPhotosAnswerTest extends TestCase
{
    public function test_list_image_folder_photos_answers_your_values(): void
    {
        Attract::fake([
            'imageFolders.listImageFolderPhotos' => ListImageFolderPhotosResponse::factory()->make(['folder' => ['id' => 'Your value']]),
        ]);

        $listImageFolderPhotos = Attract::imageFolders()->listImageFolderPhotos(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $listImageFolderPhotos->folder->id);
    }
}
```

## Related

> [card] [Get the image folder tree](https://docs.fetchski-attract.com/laravel/reference/image-folders/get-image-folder-tree.md)
>
> `Attract::imageFolders()->getImageFolderTree()`

> [card] [List image folders](https://docs.fetchski-attract.com/laravel/reference/image-folders/list-image-folders.md)
>
> `Attract::imageFolders()->listImageFolders()`

> [card] [Create an image folder](https://docs.fetchski-attract.com/laravel/reference/image-folders/create-image-folder.md)
>
> `Attract::imageFolders()->createImageFolder()`

> [card] [Get an image folder](https://docs.fetchski-attract.com/laravel/reference/image-folders/get-image-folder.md)
>
> `Attract::imageFolders()->getImageFolder()`

> [card] [Replace an image folder](https://docs.fetchski-attract.com/laravel/reference/image-folders/replace-image-folder.md)
>
> `Attract::imageFolders()->replaceImageFolder()`

> [card] [Delete an image folder](https://docs.fetchski-attract.com/laravel/reference/image-folders/delete-image-folder.md)
>
> `Attract::imageFolders()->deleteImageFolder()`

> [card] [GET /image-folder/\{\_id}/photos](https://docs.fetchski-attract.com/api-reference/image-folders/list-a-folder’s-photos.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.