> ## 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 file tags

> Retrieve a list of file tags used for organizing and categorizing uploaded files

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

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "_id": "clx1234567890abcdef",
      "title": "Marketing Materials",
      "slug": "marketing-materials",
      "type": "@apostrophecms/file-tag",
      "archived": false,
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

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

**1. Add the controller**

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

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

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

**2. Add the route**

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

const ListFileTagsController = () => import('#controllers/list_file_tags_controller')

router.get('/file-tag', [ListFileTagsController])
```

**3. Call it**

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

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

> [accordion] Optional parameters
>
> One object, e.g. `listFileTags({ aposMode })`; leave out the optional fields.
>
> **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.
>
> **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).
>
> **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 `FileTagList`. A page of FileTag documents. Read its properties (`fileTagList.results`): 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`).
>
> **results** `readonly FileTag[]`
>
> **Always sent.** A list of `FileTag`. This page’s documents; empty past the last page.
>
> **FileTag**
>
> Built-in file tag piece type for organizing files
>
> **id** `string`
>
> **Always sent.**
>
> **title** `string`
>
> **Always sent.** Tag name.
>
> **slug** `string`
>
> **Always sent.** URL-friendly tag name.
>
> **type** `string`
>
> **Always sent.**
>
> **createdAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **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.
>
> **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`)
>
> **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.
>
> **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`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **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 `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 `listFileTagsAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listFileTagsAll()` takes `listFileTags()`’s arguments except `page`. `listFileTagsPick()` 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 fileTag of site.media().listFileTagsAll()) {
  console.log(fileTag) // 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().listFileTagsPick(['title', 'slug']) // [{ id, title, slug }, …]: every file tag, 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_file_tags.spec.ts`, then run your tests:

```ts tests/unit/media_list_file_tags.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 ListFileTagsController from '#controllers/list_file_tags_controller'

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

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

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

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

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

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

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

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

To fake `listFileTagsAll()`, answer `media.listFileTags` (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-tag](https://docs.fetchski-attract.com/api-reference/media/list-file-tags.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.