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

> This API lists the tags in the workspace with the number of articles each one has.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetokb.com/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/tags.yaml GET /tags
openapi: 3.0.3
info:
  title: NeetoKB Tags API
  description: APIs to list, create, update, delete and merge tags in a workspace.
  version: 1.0.0
servers:
  - description: NeetoKB API
    url: https://{your-subdomain}.neetokb.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /tags:
    get:
      tags:
        - Tags
      summary: List tags
      description: >-
        This API lists the tags in the workspace with the number of articles
        each one has.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - in: query
          name: search_term
          description: Partial, case-insensitive match on the tag name.
          required: false
          schema:
            type: string
        - in: query
          name: sort_by
          description: Field to sort by.
          required: false
          schema:
            type: string
            enum:
              - name
              - articles_count
            default: name
        - in: query
          name: order_by
          description: >-
            Sort direction. Defaults to `asc` for `name` and `desc` for
            `articles_count`.
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - $ref: '#/components/parameters/page_number_param'
        - $ref: '#/components/parameters/page_size_param'
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      $ref: '#/components/schemas/tag'
                  pagination:
                    $ref: '#/components/schemas/pagination'
        '401':
          $ref: '#/components/responses/unauthorized_response'
        '422':
          $ref: '#/components/responses/unprocessable_response'
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](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    page_number_param:
      in: query
      name: page_number
      description: >-
        Page of results to retrieve, starting from 1. Defaults to 1 when
        omitted.
      required: false
      schema:
        type: integer
    page_size_param:
      in: query
      name: page_size
      description: Number of results per page. Defaults to 30 when omitted.
      required: false
      schema:
        type: integer
  schemas:
    tag:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Billing
        description:
          type: string
          nullable: true
        style:
          type: string
          enum:
            - primary
            - secondary
            - info
            - success
            - warning
            - danger
          example: secondary
        articles_count:
          type: integer
          example: 2
    pagination:
      type: object
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        current_page_number:
          type: integer
        page_size:
          type: integer
  responses:
    unauthorized_response:
      description: Unauthorized - API key is missing or invalid
    unprocessable_response:
      description: >-
        Unprocessable Entity - A parameter is invalid or a rule refused the
        change. The `error` field says which.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Name can't be blank.

````

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