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

# List articles

> Articles, newest first, or in category order when `category` is set. An article is only public when it and its category are active.

**Permission:** `modules.knowledgebase.articles.read`



## OpenAPI

````yaml /docs/modules-api.yaml get /application/modules/knowledgebase/articles
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:
  /application/modules/knowledgebase/articles:
    get:
      tags:
        - Knowledge Base
      summary: List articles
      description: >-
        Articles, newest first, or in category order when `category` is set. An
        article is only public when it and its category are active.


        **Permission:** `modules.knowledgebase.articles.read`
      operationId: listKnowledgeBaseArticles
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Category slug.
        - name: featured
          in: query
          required: false
          schema:
            type: boolean
          description: Only featured articles.
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Matches title, description or content.
        - name: include_content
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Include the Markdown `content` of every item.
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - inactive
              - all
            default: active
          description: Key API only.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          description: Items per page.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Page number.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KnowledgeBaseArticle'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
              example:
                data:
                  - id: 102
                    title: The status page addon
                    slug: status-page-addon
                    url: >-
                      https://billing.example.com/knowledgebase/modules-integrations/status-page-addon
                    description: >-
                      Add monitors, report incidents, schedule maintenance and
                      choose who gets notified, all from one admin page.
                    icon: null
                    is_featured: false
                    views: 2
                    order: 18
                    og_image: >-
                      https://billing.example.com/storage/knowledgebase/status-page-addon/top.webp
                    meta_title: The status page addon
                    meta_description: >-
                      Add monitors, report incidents, schedule maintenance and
                      choose who gets notified, all from one admin page.
                    category:
                      id: 13
                      name: Modules and Integrations
                      slug: modules-integrations
                    created_at: '2026-11-16T07:41:53Z'
                    updated_at: '2026-11-16T07:27:33Z'
                    status: active
                  - id: 101
                    title: The Discord webhooks addon
                    slug: discord-webhooks-addon
                    url: >-
                      https://billing.example.com/knowledgebase/modules-integrations/discord-webhooks-addon
                    description: >-
                      Post Spartan events into Discord channels, choose events
                      per webhook and follow every delivery.
                    icon: null
                    is_featured: false
                    views: 1
                    order: 17
                    og_image: >-
                      https://billing.example.com/storage/knowledgebase/discord-webhooks-addon/top.webp
                    meta_title: The Discord webhooks addon
                    meta_description: >-
                      Post Spartan events into Discord channels, choose events
                      per webhook and follow every delivery.
                    category:
                      id: 13
                      name: Modules and Integrations
                      slug: modules-integrations
                    created_at: '2026-11-16T07:41:53Z'
                    updated_at: '2026-11-16T06:42:16Z'
                    status: active
                meta:
                  request_id: 35fdc76f-fff1-4304-a7f1-849312aab135
                  pagination:
                    current_page: 1
                    per_page: 2
                    total: 100
                    last_page: 50
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                validation_failed:
                  summary: Invalid input
                  value:
                    error:
                      code: validation_failed
                      message: The request data is invalid.
                      details:
                        per_page:
                          - The per page field must not be greater than 100.
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
components:
  schemas:
    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`.
    ListMeta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id.
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - request_id
        - pagination
    ValidationError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
              description: Always `validation_failed`.
            message:
              type: string
              description: Always `The request data is invalid.`
            details:
              type: object
              properties: {}
              description: >-
                Map of field name to a list of messages. Nested fields use dot
                notation, for example `ticket_ids.0`.
              additionalProperties:
                type: array
                items:
                  type: string
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: Request id.
      description: Returned with HTTP 422 when the body or query string fails validation.
      required:
        - error
        - request_id
    KnowledgeBaseCategoryReference:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        slug:
          type: string
    Pagination:
      type: object
      properties:
        current_page:
          type: integer
          description: Current page, starting at 1.
        per_page:
          type: integer
          description: Items per page.
        total:
          type: integer
          description: Total number of matching items.
        last_page:
          type: integer
          description: Last page number.
      required:
        - current_page
        - per_page
        - total
        - last_page
    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
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 6bf04242-ac61-44b9-9dbf-b63a114b54c8
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
  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.