List blog categories

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const blogCategoryList = await site.blogCategories().listBlogCategories()

{
  "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
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const blogCategoryList = await site.blogCategories().listBlogCategories()

{
  "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.

Add the controller

app/controllers/list_blog_categories_controller.ts

import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

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

  async handle() {
    return this.site.blogCategories().listBlogCategories()
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const ListBlogCategoriesController = () => import('#controllers/list_blog_categories_controller')

router.get('/blog-category', [ListBlogCategoriesController])

Call it

Terminal

curl http://localhost:3333/blog-category

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

Optional parameters

One object, e.g. listBlogCategories({ page }); leave out the optional fields.

number | null | undefined

Optional. Leave it out and the site uses 1. Page number for pagination (1-based)

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.

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

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).

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.

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.

Returns

A 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).

readonly BlogCategory[]

Always sent. A list of BlogCategory. This page’s documents; empty past the last page.

Show BlogCategory

BlogCategory content type

string

Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

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.

string

Always sent. The document type’s name: always this type’s.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Color of this category’s badge on blog cards. Leave empty to use the site accent color.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Optional. Internal note / future category-archive intro.

Visibility | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

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.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

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.

number

Always sent. Pages in the whole list (0 when it is empty).

number

Always sent. This page, from 1.

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); catch only what you want to react to here.

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

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.

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.

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.

500

The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). Read: siteMessage, errorName, data.

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.

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).

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.

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.

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: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 (milliseconds) in config/attract.ts 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.

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const blogCategory of site.blogCategories().listBlogCategoriesAll()) {
  console.log(blogCategory) // the next page is fetched as you iterate
}

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.blogCategories().listBlogCategoriesPick(['title', 'slug']) // [{ id, title, slug }, …]: every blog category, 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/blog_categories_list_blog_categories.spec.ts, then run your tests:

tests/unit/blog_categories_list_blog_categories.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListBlogCategoriesController from '#controllers/list_blog_categories_controller'

test('blogCategories.listBlogCategories', async () => {
  const site = fakeAttract()

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

  site.assertCalled('blogCategories.listBlogCategories')
})

Terminal

node ace test

Answer with your own values: fake blogCategories.listBlogCategories with a sequence() of pages, each factories.BlogCategoryList({...}), and walk listBlogCategoriesAll().

tests/unit/blog_categories_list_blog_categories_answers.spec.ts

import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

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

  const walked: unknown[] = []
  for await (const blogCategory of site.blogCategories().listBlogCategoriesAll()) {
    walked.push(blogCategory)
  }
  assert.lengthOf(walked, 2)
})

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

List a blog category’s locales

site.blogCategories().getBlogCategoryLocales()

Create a blog category

site.blogCategories().createBlogCategory()

Get a blog category

site.blogCategories().getBlogCategory()

Replace a blog category

site.blogCategories().replaceBlogCategory()

Delete a blog category

site.blogCategories().deleteBlogCategory()

Update a blog category

site.blogCategories().updateBlogCategory()

GET /blog-category

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const blogCategoryList = await site.blogCategories().listBlogCategories()

{
  "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
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

More examples

Test it

List a blog category’s locales

Create a blog category

Get a blog category

Replace a blog category

Delete a blog category

Update a blog category

GET /blog-category

In your app

Behavior

More examples

Test it

Related

List a blog category’s locales

Create a blog category

Get a blog category

Replace a blog category

Delete a blog category

Update a blog category

GET /blog-category