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

> The photos of the feed’s latest successful run, in the feed’s order.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listPhotoFeedPhotos = await site.photoFeeds().listPhotoFeedPhotos({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
```

```json 200 wrap theme={"dark"}
{
  "feed": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "generation": "Example generation",
    "refreshedAt": "2026-10-24T09:30:00.000Z"
  },
  "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 function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/list-photo-feed-photos.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function listPhotoFeedPhotos(site: SiteClient, id: string) {
  return site.photoFeeds().listPhotoFeedPhotos({ id });
}
```

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/list-photo-feed-photos.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { listPhotoFeedPhotos } from '../src/attract/list-photo-feed-photos.ts';

const site = createSiteClient();
console.log(await listPhotoFeedPhotos(site, 'clx8m2k4p0000a1b2c3d4e5f6'));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/list-photo-feed-photos.ts
```

A route handler, a job or a queue worker calls it the same way.

A feed that has never run returns none.

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

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.photoFeeds().listPhotoFeedsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined
```

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

> [accordion] Required parameters
>
> One object, e.g. `listPhotoFeedPhotos({ id })`; leave out the optional fields.
>
> **id** `string` *required*
>
> **Required.** The feed’s document ID.

> [accordion] Optional parameters
>
> **max** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `500`. At most this many photos. 1 to 500.

> [accordion] Returns
>
> A `ListPhotoFeedPhotosResponse`. The feed and its photos. Read its properties (`listPhotoFeedPhotos.feed`): 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`).
>
> **feed** `ListPhotoFeedPhotosResponseFeed`
>
> **Always sent.** A `ListPhotoFeedPhotosResponseFeed`.
>
> **ListPhotoFeedPhotosResponseFeed**
>
> Required.
>
> **id** `string`
>
> **Always sent.**
>
> **title** `string`
>
> **Always sent.**
>
> **generation** `string | null`
>
> **Always sent, can be `null`.** The run these photos came from; null before the first.
>
> **refreshedAt** `Date | null`
>
> **Always sent, can be `null`.** When the feed last ran, successful or not. Format: an ISO 8601 date and time.
>
> **results** `readonly GalleryPhoto[]`
>
> **Always sent.** A list of `GalleryPhoto`.
>
> **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**
>
> **id** `string`
>
> **Always sent.**
>
> **name** `string`
>
> **Always sent.** The file name, without its extension.
>
> **extension** `string`
>
> **Always sent.**
>
> **urls** `Readonly\<Record\<string, string\>\>`
>
> **Always sent.** Size name (`max`, `full`, `two-thirds`, `one-half`, `one-third`, `one-sixth`, `original`) → URL.
>
> **width** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out.
>
> **height** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **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.
>
> **title** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out.
>
> **alt** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Alt text; empty when none is set.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **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.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/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`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `photo-feeds: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` (milliseconds) on the client for longer.

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/photoFeeds-listPhotoFeedPhotos.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { listPhotoFeedPhotos } from '../src/attract/list-photo-feed-photos.ts';

test('photoFeeds.listPhotoFeedPhotos', async () => {
  const site = fakeSite();
  await listPhotoFeedPhotos(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('photoFeeds.listPhotoFeedPhotos', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});
```

**Answer with your own values:** fake `photoFeeds.listPhotoFeedPhotos` with `factories.ListPhotoFeedPhotosResponse({...})`, the fields you give over a valid example (nested ones too).

```ts tests/photoFeeds-listPhotoFeedPhotos-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('photoFeeds.listPhotoFeedPhotos answers your values', async () => {
  const site = fakeSite({
    'photoFeeds.listPhotoFeedPhotos': factories.ListPhotoFeedPhotosResponse({ feed: { id: 'Your value' } })
  });
  const listPhotoFeedPhotos = await site.photoFeeds().listPhotoFeedPhotos({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(listPhotoFeedPhotos.feed.id, 'Your value');
});
```

## Related

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

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

> [card] [Get a photo feed](https://docs.fetchski-attract.com/typescript/reference/photo-feeds/get-photo-feed.md)
>
> `site.photoFeeds().getPhotoFeed()`

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

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

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

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