> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dezerx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a category (public)

> One category with its articles (without content). The key API accepts id or slug and includes inactive articles; the public API takes the slug of an active category.

This is the public, keyless version. It only returns what an anonymous visitor can see on your site, is cached for 60 seconds (edits in the admin area show up at once) and allows 60 requests per minute per IP.

**Authentication:** none, no API key needed.

**Rate limit:** 60 requests per minute per IP.



## OpenAPI

````yaml /docs/modules-api.yaml get /public/modules/knowledgebase/categories/{category}
openapi: 3.1.0
info:
  title: Spartan Module API
  version: '2026.11'
  description: >-
    Endpoints added by modules. Key endpoints live under
    `/api/application/modules/<module>/` and need an API key with the module
    permission. Content modules (Blog, News, Knowledge Base, Status) also offer
    keyless read only endpoints under `/api/public/modules/<module>/` that only
    return what an anonymous visitor can see.
servers:
  - url: https://{domain}/api
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Blog
  - name: Blog (public)
  - name: News
  - name: News (public)
  - name: Knowledge Base
  - name: Knowledge Base (public)
  - name: Status
  - name: Status (public)
  - name: Forms
  - name: Affiliates
  - name: Deprecated endpoints
paths:
  /public/modules/knowledgebase/categories/{category}:
    get:
      tags:
        - Knowledge Base (public)
      summary: Get a category (public)
      description: >-
        One category with its articles (without content). The key API accepts id
        or slug and includes inactive articles; the public API takes the slug of
        an active category.


        This is the public, keyless version. It only returns what an anonymous
        visitor can see on your site, is cached for 60 seconds (edits in the
        admin area show up at once) and allows 60 requests per minute per IP.


        **Authentication:** none, no API key needed.


        **Rate limit:** 60 requests per minute per IP.
      operationId: getKnowledgeBaseCategoryPublic
      parameters:
        - name: category
          in: path
          required: true
          description: Category slug. The key API also accepts the numeric id.
          schema:
            type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    allOf:
                      - $ref: '#/components/schemas/KnowledgeBaseCategory'
                      - type: object
                        properties:
                          articles:
                            type: array
                            items:
                              $ref: '#/components/schemas/KnowledgeBaseArticle'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  id: 1
                  name: Getting started
                  slug: getting-started
                  url: https://billing.example.com/knowledgebase/getting-started
                  description: First steps with your account and services.
                  game: Minecraft
                  icon: book
                  order: 0
                  meta_title: Install a Minecraft mod
                  meta_description: Upload a mod and restart your server.
                  articles_count: 1
                  created_at: '2025-12-05T17:56:07Z'
                  updated_at: '2025-12-05T17:56:20Z'
                  articles:
                    - id: 1
                      title: How to install a mod on your Minecraft server
                      slug: install-a-minecraft-mod
                      url: >-
                        https://billing.example.com/knowledgebase/getting-started/install-a-minecraft-mod
                      description: null
                      icon: null
                      is_featured: true
                      views: 7
                      order: 0
                      og_image: null
                      meta_title: null
                      meta_description: null
                      category:
                        id: 1
                        name: Getting started
                        slug: getting-started
                      created_at: '2025-12-05T17:57:38Z'
                      updated_at: '2026-07-30T07:43:24Z'
                meta:
                  request_id: 658ef269-59e9-4ea7-8320-ccf1abd44527
          headers:
            Cache-Control:
              description: '`public, max-age=60`.'
              schema:
                type: string
            X-Cache:
              description: '`HIT` when served from the 60 second cache, `MISS` otherwise.'
              schema:
                type: string
                enum:
                  - HIT
                  - MISS
            X-RateLimit-Limit:
              description: Requests allowed per minute.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left in the current minute.
              schema:
                type: integer
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  summary: Unknown or inactive category
                  value:
                    error:
                      code: not_found
                      message: Category not found.
                      details: {}
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security: []
components:
  schemas:
    KnowledgeBaseCategory:
      type: object
      properties:
        id:
          type: integer
          description: Category id.
        name:
          type: string
        slug:
          type: string
        url:
          type: string
          format: uri
        description:
          type:
            - string
            - 'null'
        game:
          type:
            - string
            - 'null'
          description: Optional grouping used by the `game` filter.
        icon:
          type:
            - string
            - 'null'
        order:
          type: integer
          description: Sort order.
        meta_title:
          type:
            - string
            - 'null'
        meta_description:
          type:
            - string
            - 'null'
        articles_count:
          type: integer
          description: Number of active articles.
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        status:
          type: string
          enum:
            - active
            - inactive
          description: Key API only.
    KnowledgeBaseArticle:
      type: object
      properties:
        id:
          type: integer
          description: Article id.
        title:
          type: string
        slug:
          type: string
        url:
          type:
            - string
            - 'null'
          format: uri
        description:
          type:
            - string
            - 'null'
        icon:
          type:
            - string
            - 'null'
        is_featured:
          type: boolean
        views:
          type: integer
        order:
          type: integer
        og_image:
          type:
            - string
            - 'null'
          description: Absolute image URL.
        meta_title:
          type:
            - string
            - 'null'
        meta_description:
          type:
            - string
            - 'null'
        category:
          oneOf:
            - $ref: '#/components/schemas/KnowledgeBaseCategoryReference'
            - type: 'null'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        status:
          type: string
          enum:
            - active
            - inactive
          description: Key API only. `inactive` when the article or its category is off.
        content:
          type: string
          description: >-
            Markdown body. On single article responses, or lists with
            `include_content=1`.
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
    KnowledgeBaseCategoryReference:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        slug:
          type: string
  responses:
    TooManyRequests:
      description: Rate limit reached. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds until the limit resets.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed per minute.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current minute.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: too_many_requests
              message: >-
                Too many requests. Retry after the number of seconds in the
                Retry-After header.
              details: {}
            request_id: db4f5a74-f1c8-4554-a36b-7dced81670a8
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.