> ## 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 a photo feed

> Retrieve a specific photo feed by ID.

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

$photoFeed = Attract::photoFeeds()->getPhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "feedConnectionId": "clx8m2k4p0000a1b2c3d4e5f6",
  "feedPrefix": "Example feed prefix",
  "feedLayout": "ymd",
  "slug": "example-slug",
  "visibility": "public",
  "feedDateRule": "recentDays",
  "feedRecentDays": 5,
  "feedYears": 2,
  "feedRangeStart": "2026-10-24",
  "feedRangeEnd": "2026-10-24",
  "feedDistribution": "total",
  "feedTargetCount": 30,
  "feedPerDayCount": 10,
  "feedAvoidRepeats": true,
  "feedSeenLimit": 2000,
  "feedFormat": "webp",
  "feedMaxDimension": 2000,
  "feedQuality": 82,
  "feedAspect": "original",
  "feedAltText": "Example feed alt text",
  "feedEnabled": false,
  "feedInterval": "6",
  "feedRetainMinutes": 30,
  "feedLastRunAt": "2026-10-24T09:30:00.000Z",
  "feedLastStatus": "Example feed last status",
  "feedPhotoCount": 1,
  "feedLastError": "Example feed last error",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class GetPhotoFeedController
{
    public function __invoke(string $id): PhotoFeed
    {
        return Attract::photoFeeds()->getPhotoFeed(id: $id);
    }
}
```

**2. Add the route**

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

Route::get('/photo-feed/{id}', GetPhotoFeedController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/photo-feed/clx8m2k4p0000a1b2c3d4e5f6
```

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

## Call it from the terminal

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

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

## 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::photoFeeds()->listPhotoFeedsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call photoFeeds.listPhotoFeedsPick 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. `getPhotoFeed(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **Required.** The document’s `_id`: a full id names its own locale and mode (the draft’s `…:en:draft`, the published one’s `…:en:published`; no `aposMode` needed), a bare `aposDocId` takes the request’s (`aposLocale`, `aposMode`).

> [accordion] Optional parameters
>
> **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.

> [accordion] Returns
>
> A `PhotoFeed` (`Fetchski\AttractCmsLaravel\Data\PhotoFeed`). PhotoFeed content type. Read its properties (`$photoFeed->title`): 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`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **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.
>
> **feedConnectionId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Which external photo store to draw from. Connections (bucket, region, keys) are set up once in Connections → Photo storage.
>
> **feedPrefix** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. The folder inside the bucket the dated folders live under — leave empty when they sit at the top level (e.g. “2026/May/31/…”).
>
> **feedLayout** `Enums\\FeedLayout|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. How deep the dated folders go. The month and day folder NAMES don’t matter — “May”, “05” and “5” are all understood — only the depth. One of `ymd`, `ym`, `y`, `flat`; a newer site may send others, so keep a fallback.
>
> **feedDateRule** `Enums\\FeedDateRule|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Which dates this feed is allowed to pull from. Only the folders inside this window are ever listed, so a huge library stays cheap to sample. One of `recentDays`, `thisYear`, `lastYears`, `range`, `all`; a newer site may send others, so keep a fallback.
>
> **feedRecentDays** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Counting today. 5 means today and the four days before it. 1 to 365.
>
> **feedYears** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Counting this one. 2 means this calendar year and last. 1 to 25.
>
> **feedRangeStart** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. From. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **feedRangeEnd** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. To. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **feedDistribution** `Enums\\FeedDistribution|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Spread samples one target count across as many different days as possible (best for a wide window). Every day takes the same number from each day in the window (best for a daily-update wall). One of `total`, `perDay`; a newer site may send others, so keep a fallback.
>
> **feedTargetCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. How many photos this feed shows. Each refresh replaces the whole set. 1 to 500.
>
> **feedPerDayCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Taken from every day in the window — 10 from each of the last 5 days is 50 photos. 1 to 200.
>
> **feedAvoidRepeats** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Remember which photos were used and prefer ones that haven’t been shown lately, so a big library keeps producing new sets. When a date window runs out of unseen photos it reuses the oldest ones rather than showing fewer.
>
> **feedSeenLimit** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. The size of that memory. Bigger means longer before a photo can repeat; 0 turns the memory off. 0 to 20000.
>
> **feedFormat** `Enums\\FeedFormat|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Every photo is re-encoded on the way in — which also strips camera metadata (location, device) from what the site serves. One of `webp`, `jpeg`; a newer site may send others, so keep a fallback.
>
> **feedMaxDimension** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Photos larger than this are scaled down. 2000 is plenty for a full-screen lightbox; the gallery tiles use much smaller generated sizes. 320 to 6000.
>
> **feedQuality** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Encoder quality, 40–100. 82 is a good balance; above 90 grows files fast with little visible gain.
>
> **feedAspect** `Enums\\FeedAspect|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Keep each photo’s own proportions (best for the Mosaic and Masonry layouts), or crop everything to one shape for a perfectly uniform wall. Crops are centered on the busiest part of the photo. One of `original`, `1:1`, `4:3`, `3:2`, `16:9`, `4:5`; a newer site may send others, so keep a fallback.
>
> **feedAltText** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. Describes what these photos generally show, for screen readers and the lightbox caption. Applied to each photo as it is imported — leave empty to import them without alt text.
>
> **feedEnabled** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Master switch. When off, the feed keeps showing its current photos and only refreshes when you run it by hand.
>
> **feedInterval** `Enums\\FeedInterval|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. How often to fetch a fresh set. Change it anytime — no restart. One of `1`, `2`, `3`, `4`, `6`, `12`, `24`, `48`; a newer site may send others, so keep a fallback.
>
> **feedRetainMinutes** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. After a refresh the old photos stop being shown immediately, but their files are kept this long before being deleted — a safety margin for pages already sent to a browser and for CDN caches. 0 deletes them right away. 0 to 10080.
>
> **feedLastRunAt** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Set automatically. The schedule paces the next refresh off this.
>
> **feedLastStatus** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Last result.
>
> **feedPhotoCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Photos showing.
>
> **feedLastError** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Why the last refresh failed, when it did. A failed refresh never empties the gallery — the previous photos keep showing.
>
> **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.

> [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:photo-feeds:read` (or a master above it: `content:photo-feeds:all`, `content:all`, `admin:all`) reads the published documents. 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.

## More examples

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

$photoFeed = Attract::photoFeeds()->findPhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6'); // ?PhotoFeed: null when the site answers 404
```

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetPhotoFeedTest extends TestCase
{
    public function test_get_photo_feed(): void
    {
        Attract::fake();

        $this->getJson('/photo-feed/clx8m2k4p0000a1b2c3d4e5f6')->assertOk();

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

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

**Answer with your own values:** fake `photoFeeds.getPhotoFeed` with `PhotoFeed::factory()->make([...])`, the fields you give over a valid example.

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetPhotoFeedAnswerTest extends TestCase
{
    public function test_get_photo_feed_answers_your_values(): void
    {
        Attract::fake([
            'photoFeeds.getPhotoFeed' => PhotoFeed::factory()->make(['title' => 'Your value']),
        ]);

        $photoFeed = Attract::photoFeeds()->getPhotoFeed(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $photoFeed->title);
    }
}
```

## Related

> [card] [List a feed’s photos](https://docs.fetchski-attract.com/laravel/reference/photo-feeds/list-photo-feed-photos.md)
>
> `Attract::photoFeeds()->listPhotoFeedPhotos()`

> [card] [List photo feeds](https://docs.fetchski-attract.com/laravel/reference/photo-feeds/list-photo-feeds.md)
>
> `Attract::photoFeeds()->listPhotoFeeds()`

> [card] [Create a photo feed](https://docs.fetchski-attract.com/laravel/reference/photo-feeds/create-photo-feed.md)
>
> `Attract::photoFeeds()->createPhotoFeed()`

> [card] [Replace a photo feed](https://docs.fetchski-attract.com/laravel/reference/photo-feeds/replace-photo-feed.md)
>
> `Attract::photoFeeds()->replacePhotoFeed()`

> [card] [Delete a photo feed](https://docs.fetchski-attract.com/laravel/reference/photo-feeds/delete-photo-feed.md)
>
> `Attract::photoFeeds()->deletePhotoFeed()`

> [card] [Update a photo feed](https://docs.fetchski-attract.com/laravel/reference/photo-feeds/update-photo-feed.md)
>
> `Attract::photoFeeds()->updatePhotoFeed()`

> [card] [GET /photo-feed/\{\_id}](https://docs.fetchski-attract.com/api-reference/photo-feeds/get-a-photo-feed.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.