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

# Get my preferences

> This API returns the preferences of the signed-in user. It works only for a signed-in user, such as a CLI session. An API key has no user, so the request is refused.

> [!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/my-preferences.yaml GET /my_preferences
openapi: 3.0.3
info:
  title: NeetoKB My Preferences API
  description: APIs to read and update the preferences of the signed-in user.
  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:
  /my_preferences:
    get:
      tags:
        - My preferences
      summary: Get my preferences
      description: >-
        This API returns the preferences of the signed-in user. It works only
        for a signed-in user, such as a CLI session. An API key has no user, so
        the request is refused.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/my_preferences'
        '401':
          $ref: '#/components/responses/unauthorized_response'
        '422':
          $ref: '#/components/responses/no_user_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
  schemas:
    my_preferences:
      type: object
      properties:
        monthly_reports_mail:
          type: boolean
          example: true
  responses:
    unauthorized_response:
      description: Unauthorized - API key is missing or invalid
    no_user_response:
      description: >-
        Unprocessable Entity - The request used an API key, which has no
        signed-in user
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: >-
                  My preferences belong to a signed-in user, so they are not
                  available with an API key.

````

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