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

# List articles

> This API allows to get a list of all articles.

<Warning>
  **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
  the [v2 equivalent](/api-reference) for improved REST compliance (correct HTTP status codes,
  consistent response envelopes, and hyphenated URLs).
</Warning>

<Info>Replace `{your-subdomain}` with your workspace's subdomain. <br /> Learn how to find your subdomain in [Workspace subdomain](/getting-started/workspace-subdomain).</Info>


## OpenAPI

````yaml bundled-v1/articles.yaml GET /articles
openapi: 3.0.3
info:
  title: NeetoKB Articles API
  version: 1.0.0
servers:
  - description: NeetoKB API
    url: https://{your-subdomain}.neetokb.com/api/external/v1
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/getting-started/workspace-subdomain).
security: []
paths:
  /articles:
    get:
      summary: List all articles
      description: This API allows to get a list of all articles.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/category_id_param'
        - $ref: '#/components/parameters/page_number_param'
        - $ref: '#/components/parameters/page_size_param'
        - in: query
          name: search_term
          description: Search term to filter articles.
          required: false
          schema:
            type: string
          example: getting
        - in: query
          name: state
          description: Status of the article.
          required: false
          schema:
            type: string
            enum:
              - draft
              - published
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  articles:
                    type: array
                    items:
                      $ref: '#/components/schemas/article'
                  pagination:
                    $ref: '#/components/schemas/pagination'
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/getting-started/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    category_id_param:
      in: query
      name: category_id
      description: >-
        Unique identifier of the category. Refer to [Getting the Category
        ID](/getting-started/getting-category-id) section for detailed
        instructions.
      required: false
      schema:
        type: string
        format: uuid
    page_number_param:
      in: query
      name: page_number
      description: >-
        Retrieve paginated results by specifying the desired page number.
        Defaulting to 1 when omitted.
      required: false
      schema:
        type: integer
    page_size_param:
      in: query
      name: page_size
      description: >-
        Set the number of results returned in the response. Defaulting to 30
        when omitted.
      required: false
      schema:
        type: integer
  schemas:
    article:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
          example: getting-started
        title:
          type: string
          example: Getting Started Guide
        state:
          type: string
          enum:
            - draft
            - published
          example: published
        unique_views_count:
          type: integer
          example: 42
        category:
          $ref: '#/components/schemas/category'
    pagination:
      type: object
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        current_page_number:
          type: integer
        page_size:
          type: integer
    category:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string

````