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

> Retrieve a paginated list of image folders.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const imageFolderList = await site.imageFolders().listImageFolders()
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "_parent": [
        {}
      ],
      "referenceOnly": false,
      "slug": "example-slug",
      "visibility": "public",
      "archived": false,
      "folderPath": "Example folder path",
      "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "slugSegment": "Example slug segment",
      "level": 0,
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

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

**1. Add the controller**

```ts app/controllers/list_image_folders_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListImageFoldersController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.imageFolders().listImageFolders()
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ListImageFoldersController = () => import('#controllers/list_image_folders_controller')

router.get('/image-folder', [ListImageFoldersController])
```

**3. Call it**

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

With `node ace serve` running, it prints its answer as JSON.

> [accordion] Optional parameters
>
> One object, e.g. `listImageFolders({ page })`; leave out the optional fields.
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `number | null | undefined`
>
> **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 | null | undefined`
>
> **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).
>
> **renderAreas** `boolean | null | undefined`
>
> **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 | null | undefined`
>
> **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
>
> An `ImageFolderList`. A page of ImageFolder documents. Read its properties (`imageFolderList.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`, `_parent` → `parent`).
>
> **results** `readonly ImageFolder[]`
>
> **Always sent.** A list of `ImageFolder`. This page’s documents; empty past the last page.
>
> **ImageFolder**
>
> ImageFolder 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.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `Visibility`
>
> **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** `Date`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **parent** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The related `image-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.
>
> **referenceOnly** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.
>
> **archived** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **folderPath** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Its place in the tree: each folder’s URL name from the top, joined by `/` (`albums/summer`). Set by the site from `_parent` and `title`; a value sent is ignored.
>
> **folderParentId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The parent folder’s id, empty at the top. Set by the site from `_parent`; a value sent is ignored.
>
> **slugSegment** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Its own part of `folderPath`, made from its title. Set by the site; a value sent is ignored.
>
> **level** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How deep it sits: 0 at the top. Set by the site from `_parent`; a value sent is ignored.
>
> **linkedAlbumId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **linkedFeedId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **linkedDocId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **pages** `number`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `number`
>
> **Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **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`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:images:read` (or a master above it: `content:images: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` (milliseconds) in `config/attract.ts` for longer.
* **Paging:** one page per call. To walk them all, use `listImageFoldersAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

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

```ts Every page wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const imageFolder of site.imageFolders().listImageFoldersAll()) {
  console.log(imageFolder) // the next page is fetched as you iterate
}
```

```ts Only some fields wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const rows = await site.imageFolders().listImageFoldersPick(['title', 'slug']) // [{ id, title, slug }, …]: every image folder, across every page
```

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/image_folders_list_image_folders.spec.ts`, then run your tests:

```ts tests/unit/image_folders_list_image_folders.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListImageFoldersController from '#controllers/list_image_folders_controller'

test('imageFolders.listImageFolders', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListImageFoldersController)
  await controller.handle()

  site.assertCalled('imageFolders.listImageFolders')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `imageFolders.listImageFolders` with a `sequence()` of pages, each `factories.ImageFolderList({...})`, and walk `listImageFoldersAll()`.

```ts tests/unit/image_folders_list_image_folders_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

test('imageFolders.listImageFolders answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'imageFolders.listImageFolders': sequence(
      factories.ImageFolderList({ currentPage: 1, pages: 2 }),
      factories.ImageFolderList({ currentPage: 2, pages: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const imageFolder of site.imageFolders().listImageFoldersAll()) {
    walked.push(imageFolder)
  }
  assert.lengthOf(walked, 2)
})
```

To fake `listImageFoldersAll()`, answer `imageFolders.listImageFolders` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

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

> [card] [List a folder’s photos](https://docs.fetchski-attract.com/adonisjs/reference/image-folders/list-image-folder-photos.md)
>
> `site.imageFolders().listImageFolderPhotos()`

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

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

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

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

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