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

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

$fileTagList = Attract::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**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListFileTagsController
{
    public function __invoke(): FileTagList
    {
        return Attract::media()->listFileTags();
    }
}
```

**2. Add the route**

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

Route::get('/file-tag', ListFileTagsController::class);
```

**3. Call it**

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

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call media.listFileTags
```

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

```bash Terminal theme={"dark"}
php artisan attract:call media.listFileTagsPick fields=title,slug
```

Only the fields you name, for every document across every page: [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Optional parameters
>
> Named arguments, e.g. `listFileTags(aposMode: …)`; leave out the optional ones.
>
> **aposMode** `Enums\\AposMode|string|null`
>
> **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`
>
> **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** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **page** `?int`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `?int`
>
> **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`
>
> **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`
>
> **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` (`Fetchski\AttractCmsLaravel\Data\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** `Collection\<int, FileTag\>`
>
> **Always sent.** A list of `FileTag`. This page’s documents; empty past the last page.
>
> **FileTag (Fetchski\AttractCmsLaravel\Data\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** `CarbonImmutable`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **updatedAt** `CarbonImmutable`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **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.
>
> **copyOfId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The `_id` of the piece/page that was copied to create this document (only present if created via `_copyingId`)
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `int`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `int`
>
> **Always sent.** This page, from 1.

> [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)).
>
> **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`
>
> `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: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` in `config/fetchski-attract.php` 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.

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

$fileTags = Attract::media()->listFileTagsAll(); // LazyCollection<int, FileTag>: the next page is fetched as you iterate
```

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

$rows = Attract::media()->listFileTagsPick(fields: ['title', 'slug']); // LazyCollection of ['id' => …, 'title' => …, 'slug' => …]: every file tag, across every page
```

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListFileTagsTest extends TestCase
{
    public function test_list_file_tags(): void
    {
        Attract::fake();

        $this->getJson('/file-tag')->assertOk();

        Attract::assertCalled('media.listFileTags');
    }
}
```

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

**Answer with your own values:** fake `media.listFileTags` with a `sequence()` of pages, each `FileTagList::factory()->make([...])`, and walk `listFileTagsAll()`.

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListFileTagsAnswerTest extends TestCase
{
    public function test_list_file_tags_answers_your_values(): void
    {
        Attract::fake([
            'media.listFileTags' => Attract::sequence(
                FileTagList::factory()->make(['currentPage' => 1, 'pages' => 2]),
                FileTagList::factory()->make(['currentPage' => 2, 'pages' => 2]),
            ),
        ]);

        $fileTags = Attract::media()->listFileTagsAll();

        $this->assertCount(2, $fileTags->all());
    }
}
```

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/laravel/reference/media/list-images.md)
>
> `Attract::media()->listImages()`

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

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

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

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

> [card] [Publish images](https://docs.fetchski-attract.com/laravel/reference/media/publish-images.md)
>
> `Attract::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.