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

> Retrieve a paginated list of files from the media library

```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 fileObjectList = await site.media().listFiles()
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "_id": "clx1234567890abcdef",
      "title": "Company Brochure",
      "slug": "company-brochure",
      "type": "@apostrophecms/file",
      "archived": false,
      "visibility": "public",
      "attachment": {
        "_id": "ckj0akbxa003vp39kfbxgb8zg",
        "_url": "https://example.net/uploads/attachments/ckj0akbxa003vp39kfbxgb8zg-blue-box.png",
        "_urls": {
          "key": "Example value"
        },
        "name": "blue-box",
        "title": "blue box",
        "extension": "png",
        "type": "attachment",
        "group": "images",
        "length": 10497,
        "md5": "630eeaaecd0bdc07c4a82eeca4c07588",
        "width": 600,
        "height": 106,
        "landscape": true,
        "portrait": true,
        "docIds": [
          "clx8m2k4p0000a1b2c3d4e5f6"
        ],
        "archivedDocIds": [
          "clx8m2k4p0000a1b2c3d4e5f6"
        ],
        "createdAt": "2026-10-24T09:30:00.000Z",
        "updatedAt": "2026-10-24T09:30:00.000Z",
        "_isCroppable": true,
        "crop": {},
        "used": true,
        "folderId": "clx8m2k4p0000a1b2c3d4e5f6",
        "folderPath": "Example folder path"
      },
      "description": "Example description",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
      "_folder": [
        {}
      ],
      "_tags": [
        {}
      ],
      "_url": "https://acme.example/example",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

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

**1. Add the controller**

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

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

  async handle() {
    return this.site.media().listFiles()
  }
}
```

**2. Add the route**

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

const ListFilesController = () => import('#controllers/list_files_controller')

router.get('/file', [ListFilesController])
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:3333/file
```

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

> [accordion] Optional parameters
>
> One object, e.g. `listFiles({ 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).
>
> **aposMode** `AposMode | null | undefined`
>
> **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 | null | undefined`
>
> **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** `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
>
> A `FileObjectList`. A page of FileObject documents. Read its properties (`fileObjectList.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`, `_tags` → `tags` …).
>
> **results** `readonly FileObject[]`
>
> **Always sent.** A list of `FileObject`. This page’s documents; empty past the last page.
>
> **FileObject**
>
> Built-in file piece type for general file uploads (PDFs, documents, etc.)
>
> **id** `string`
>
> **Always sent.** Unique identifier.
>
> **slug** `string`
>
> **Always sent.** Its URL name: lowercase words joined by hyphens.
>
> **type** `string`
>
> **Always sent.**
>
> **visibility** `Visibility`
>
> **Always sent.** Who may see it on the site: `public` (everyone) or `loginRequired` (signed-in people only). One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **createdAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **title** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. File title/description.
>
> **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.
>
> **attachment** `Attachment`
>
> **Sometimes sent:** `undefined` when the site leaves it out. An `Attachment`. File attachment information from upload endpoint.
>
> **Attachment**
>
> **id** `string`
>
> **Always sent.** Unique attachment identifier.
>
> **name** `string`
>
> **Always sent.** Slugified filename.
>
> **title** `string`
>
> **Always sent.** Sortified filename.
>
> **extension** `string`
>
> **Always sent.** File extension.
>
> **type** `string`
>
> **Always sent.** Always `attachment`.
>
> **group** `string`
>
> **Always sent.** File group type.
>
> **length** `number`
>
> **Always sent.** File size in bytes.
>
> **md5** `string`
>
> **Always sent.** MD5 checksum.
>
> **docIds** `readonly string[]`
>
> **Always sent.** IDs of documents using this attachment.
>
> **archivedDocIds** `readonly string[]`
>
> **Always sent.** IDs of archived documents using this attachment.
>
> **createdAt** `Date`
>
> **Always sent.** When it was uploaded (ISO 8601). Format: an ISO 8601 date and time.
>
> **url** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The file’s URL: set for a file that is not an image. An image’s URLs are in `_urls`, by size (`original` is the file as uploaded).
>
> **urls** `Readonly\<Record\<string, string\>\>`
>
> **Sometimes sent:** `undefined` when the site leaves it out. An image’s URLs by size (`original`, `max`, `full`, `two-thirds`, `one-half`, `one-third`, `one-sixth`); unset for other files.
>
> **width** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Image width in pixels (images only)
>
> **height** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Image height in pixels (images only)
>
> **landscape** `boolean`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Whether image is landscape orientation (images only)
>
> **portrait** `boolean`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Whether image is portrait orientation (images only)
>
> **updatedAt** `Date`
>
> **Sometimes sent:** `undefined` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **isCroppable** `boolean`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Whether the image can be cropped.
>
> **crop** `Readonly\<Record\<string, unknown\>\> | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The crop applied, if any (`top`, `left`, `width`, `height`).
>
> **used** `boolean`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Whether any document uses the file.
>
> **folderId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The media folder holding the file, by its `aposDocId`.
>
> **folderPath** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. That folder’s path, e.g. `events/summer`.
>
> **description** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. File description.
>
> **copyOfId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The `_id` of the piece/page that was copied to create this document (only present if created via `_copyingId`)
>
> **folder** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The media folder holding it (one at most; empty at the library’s root).
>
> **tags** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Its tags, as documents.
>
> **url** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The file’s URL (the attachment’s `_url`). Format: an absolute URL.
>
> **aposShareKey** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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** `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:files:read` (or a master above it: `content:files:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:files: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` (milliseconds) in `config/attract.ts` for longer.
* **Paging:** one page per call. To walk them all, use `listFilesAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listFilesAll()` takes `listFiles()`’s arguments except `page`. `listFilesPick()` 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 fileObject of site.media().listFilesAll()) {
  console.log(fileObject) // 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.media().listFilesPick(['title', 'slug']) // [{ id, title, slug }, …]: every file, 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/media_list_files.spec.ts`, then run your tests:

```ts tests/unit/media_list_files.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 ListFilesController from '#controllers/list_files_controller'

test('media.listFiles', async () => {
  const site = fakeAttract()

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

  site.assertCalled('media.listFiles')
})
```

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

**Answer with your own values:** fake `media.listFiles` with a `sequence()` of pages, each `factories.FileObjectList({...})`, and walk `listFilesAll()`.

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

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

  const walked: unknown[] = []
  for await (const fileObject of site.media().listFilesAll()) {
    walked.push(fileObject)
  }
  assert.lengthOf(walked, 2)
})
```

To fake `listFilesAll()`, answer `media.listFiles` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List images](https://docs.fetchski-attract.com/adonisjs/reference/media/list-images.md)
>
> `site.media().listImages()`

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

> [card] [Archive images](https://docs.fetchski-attract.com/adonisjs/reference/media/archive-images.md)
>
> `site.media().archiveImages()`

> [card] [Crop images to a widget’s aspect ratio](https://docs.fetchski-attract.com/adonisjs/reference/media/autocrop-images.md)
>
> `site.media().autocropImages()`

> [card] [Copy images to another locale](https://docs.fetchski-attract.com/adonisjs/reference/media/localize-images.md)
>
> `site.media().localizeImages()`

> [card] [Publish images](https://docs.fetchski-attract.com/adonisjs/reference/media/publish-images.md)
>
> `site.media().publishImages()`

> [card] [GET /@apostrophecms/file](https://docs.fetchski-attract.com/api-reference/media/list-files.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.