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

> Retrieve a paginated list of blog-categories.

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

$blogCategoryList = Attract::blogCategories()->listBlogCategories();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "color": "Example color",
      "description": "Example description",
      "slug": "example-slug",
      "visibility": "public",
      "scheduledPublish": "Example scheduled publish",
      "scheduledUnpublish": "Example scheduled unpublish",
      "archived": false,
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListBlogCategoriesController
{
    public function __invoke(): BlogCategoryList
    {
        return Attract::blogCategories()->listBlogCategories();
    }
}
```

**2. Add the route**

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

Route::get('/blog-category', ListBlogCategoriesController::class);
```

**3. Call it**

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

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call blogCategories.listBlogCategories
```

It calls `listBlogCategories()` 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 blogCategories.listBlogCategoriesPick 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. `listBlogCategories(page: …)`; leave out the optional ones.
>
> **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).
>
> **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.
>
> **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 `BlogCategoryList` (`Fetchski\AttractCmsLaravel\Data\BlogCategoryList`). A page of BlogCategory documents. Read its properties (`$blogCategoryList->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, BlogCategory\>`
>
> **Always sent.** A list of `BlogCategory`. This page’s documents; empty past the last page.
>
> **BlogCategory (Fetchski\AttractCmsLaravel\Data\BlogCategory)**
>
> BlogCategory 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).
>
> **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.
>
> **color** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Color of this category’s badge on blog cards. Leave empty to use the site accent color.
>
> **description** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. Internal note / future category-archive intro.
>
> **visibility** `Enums\\Visibility|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **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.
>
> **createdAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **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)).
>
> **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`
>
> `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:blog-categories:read` (or a master above it: `content:blog-categories:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:blog-categories:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
* **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 `listBlogCategoriesAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listBlogCategoriesAll()` takes `listBlogCategories()`’s arguments except `page`. `listBlogCategoriesPick()` 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;

$blogCategorys = Attract::blogCategories()->listBlogCategoriesAll(); // LazyCollection<int, BlogCategory>: the next page is fetched as you iterate
```

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

$rows = Attract::blogCategories()->listBlogCategoriesPick(fields: ['title', 'slug']); // LazyCollection of ['id' => …, 'title' => …, 'slug' => …]: every blog category, 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/ListBlogCategoriesTest.php`, then run your tests:

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListBlogCategoriesTest extends TestCase
{
    public function test_list_blog_categories(): void
    {
        Attract::fake();

        $this->getJson('/blog-category')->assertOk();

        Attract::assertCalled('blogCategories.listBlogCategories');
    }
}
```

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

**Answer with your own values:** fake `blogCategories.listBlogCategories` with a `sequence()` of pages, each `BlogCategoryList::factory()->make([...])`, and walk `listBlogCategoriesAll()`.

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListBlogCategoriesAnswerTest extends TestCase
{
    public function test_list_blog_categories_answers_your_values(): void
    {
        Attract::fake([
            'blogCategories.listBlogCategories' => Attract::sequence(
                BlogCategoryList::factory()->make(['currentPage' => 1, 'pages' => 2]),
                BlogCategoryList::factory()->make(['currentPage' => 2, 'pages' => 2]),
            ),
        ]);

        $blogCategorys = Attract::blogCategories()->listBlogCategoriesAll();

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

To fake `listBlogCategoriesAll()`, answer `blogCategories.listBlogCategories` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List a blog category’s locales](https://docs.fetchski-attract.com/laravel/reference/blog-categories/get-blog-category-locales.md)
>
> `Attract::blogCategories()->getBlogCategoryLocales()`

> [card] [Create a blog category](https://docs.fetchski-attract.com/laravel/reference/blog-categories/create-blog-category.md)
>
> `Attract::blogCategories()->createBlogCategory()`

> [card] [Get a blog category](https://docs.fetchski-attract.com/laravel/reference/blog-categories/get-blog-category.md)
>
> `Attract::blogCategories()->getBlogCategory()`

> [card] [Replace a blog category](https://docs.fetchski-attract.com/laravel/reference/blog-categories/replace-blog-category.md)
>
> `Attract::blogCategories()->replaceBlogCategory()`

> [card] [Delete a blog category](https://docs.fetchski-attract.com/laravel/reference/blog-categories/delete-blog-category.md)
>
> `Attract::blogCategories()->deleteBlogCategory()`

> [card] [Update a blog category](https://docs.fetchski-attract.com/laravel/reference/blog-categories/update-blog-category.md)
>
> `Attract::blogCategories()->updateBlogCategory()`

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