Kavita Users API

The Users API from Kavita — 10 operation(s) for users.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /api/Users/delete-user Delete a user account · Delete api users delete user #
Ask an LLM
“How do I remove a user from my Kavita server?”
“Can I delete a user by their user ID?”
Tell an agent destructive · confirm first
Delete user {userId}.
Remove the user account {userId} from Kavita.
GET /api/Users List all users on the server · Returns all users of this server #
Ask an LLM
“Who are all the users on my Kavita server?”
“Can I include pending users when listing users?”
Tell an agent
List all users on the server.
List users including pending ones: {includePending}.
GET /api/Users/profile-info Get a user's profile information · Get Information about a given user #
Ask an LLM
“What profile information is stored for a user?”
“Can I look up a user's profile by ID?”
Tell an agent
Get profile info for user {userId}.
Show the profile details of user {userId}.
GET /api/Users/has-profile-shared Check if a user shares their profile · Does the requested user have their profile sharing on #
Ask an LLM
“Is a user's profile sharing turned on?”
“How do I check whether a user shares their profile?”
Tell an agent
Check whether user {userId} has profile sharing on.
Tell me if user {userId} shares their profile.
GET /api/Users/has-reading-progress Check if a user has reading progress · Is there any reading progress on this library #
Ask an LLM
“Does a user have any reading progress in a library?”
“Can I check reading progress for a library?”
Tell an agent
Check if user has reading progress in library {libraryId}.
Tell me whether there is reading progress on library {libraryId}.
GET /api/Users/has-library-access Check if a user has library access · Does the user have access to this library #
Ask an LLM
“Can a user access a particular library?”
“How do I verify a user has access to a library?”
Tell an agent
Check whether user has access to library {libraryId}.
Verify user can access library {libraryId}.
POST /api/Users/update-preferences Update a user's preferences · Update the user preferences #
Ask an LLM
“How do I change my theme and locale settings in Kavita?”
“Can I prevent unread summaries from blurring?”
Tell an agent
Set the theme to {theme} with blur-unread-summaries {blur} and prompt for downloads {prompt}.
Turn off transitions {noTransitions}, use {layout} layout and set the locale to {locale}.
GET /api/Users/get-preferences Get a user's preferences · Returns the preferences of the user #
Ask an LLM
“What preferences are saved for the current user?”
“Can I fetch my own user preferences?”
Tell an agent
Get my user preferences.
Show the current user's theme, blur unread summaries and layout mode.
GET /api/Users/names List all user names · Returns a list of the user names within the system #
Ask an LLM
“What user names exist on the server?”
“Can I get just the user names without their IDs?”
Tell an agent
List all user names on the server.
Give me the names of every user.
GET /api/Users/tokens List users with registered tokens · Returns all users with tokens registered and their token information. #
Ask an LLM
“Which users have registered tokens on the server?”
“Can I see token information for each user?”
Tell an agent
List all users with registered tokens.
Show the token information for every user.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kavita:kavita-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kavita-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kavita Users API
  description: Kavita provides a set of APIs authenticated via an Auth Key passed in the `x-api-key` header. Generate an Auth Key under User Settings → Manage Auth Keys, paste it into the Authorize panel, and all Try It requests will include it. Assume all fields of a payload are required unless marked optional. Built against v0.9.1.15
  license:
    name: GPL-3.0
    url: https://github.com/Kareadita/Kavita/blob/develop/LICENSE
  version: 0.9.1.15
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:5000
security:
- AuthKey: []
tags:
- name: Users
paths:
  /api/Users/delete-user:
    delete:
      tags:
      - Users
      parameters:
      - name: userId
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Delete api users delete user
      x-summary-source: derived
      operationId: deleteApiUsersDeleteUser
      x-operation-id-source: derived
  /api/Users:
    get:
      tags:
      - Users
      summary: Returns all users of this server
      parameters:
      - name: includePending
        in: query
        description: This will include pending members
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemberDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemberDto'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MemberDto'
      operationId: getApiUsers
      x-operation-id-source: derived
  /api/Users/profile-info:
    get:
      tags:
      - Users
      summary: Get Information about a given user
      parameters:
      - name: userId
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MemberInfoDto'
            application/json:
              schema:
                $ref: '#/components/schemas/MemberInfoDto'
            text/json:
              schema:
                $ref: '#/components/schemas/MemberInfoDto'
      operationId: getApiUsersProfileInfo
      x-operation-id-source: derived
  /api/Users/has-profile-shared:
    get:
      tags:
      - Users
      summary: Does the requested user have their profile sharing on
      parameters:
      - name: userId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
      operationId: getApiUsersHasProfileShared
      x-operation-id-source: derived
  /api/Users/has-reading-progress:
    get:
      tags:
      - Users
      summary: Is there any reading progress on this library
      parameters:
      - name: libraryId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
      operationId: getApiUsersHasReadingProgress
      x-operation-id-source: derived
  /api/Users/has-library-access:
    get:
      tags:
      - Users
      summary: Does the user have access to this library
      parameters:
      - name: libraryId
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: boolean
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
      operationId: getApiUsersHasLibraryAccess
      x-operation-id-source: derived
  /api/Users/update-preferences:
    post:
      tags:
      - Users
      summary: Update the user preferences
      description: If the user has ReadOnly role, they will not be able to perform this action
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPreferencesDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UserPreferencesDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UserPreferencesDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
            application/json:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
            text/json:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
      operationId: postApiUsersUpdatePreferences
      x-operation-id-source: derived
  /api/Users/get-preferences:
    get:
      tags:
      - Users
      summary: Returns the preferences of the user
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
            application/json:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
            text/json:
              schema:
                $ref: '#/components/schemas/UserPreferencesDto'
      operationId: getApiUsersGetPreferences
      x-operation-id-source: derived
  /api/Users/names:
    get:
      tags:
      - Users
      summary: Returns a list of the user names within the system
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  type: string
            application/json:
              schema:
                type: array
                items:
                  type: string
            text/json:
              schema:
                type: array
                items:
                  type: string
      operationId: getApiUsersNames
      x-operation-id-source: derived
  /api/Users/tokens:
    get:
      tags:
      - Users
      summary: Returns all users with tokens registered and their token information.
      description: Kavita+ only
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserTokenInfoDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserTokenInfoDto'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserTokenInfoDto'
      operationId: getApiUsersTokens
      x-operation-id-source: derived
components:
  schemas:
    AppUserOpdsPreferences:
      type: object
      properties:
        embedProgressIndicator:
          type: boolean
        includeContinueFrom:
          type: boolean
      additionalProperties: false
    PageLayoutMode:
      enum:
      - 0
      - 1
      type: integer
      description: 'Members:

        - `0` — Cards

        - `1` — List'
      format: int32
      x-enum-varnames:
      - Cards
      - List
      x-enum-descriptions:
      - Cards
      - List
    RgbaColor:
      type: object
      properties:
        r:
          type: integer
          format: int32
        g:
          type: integer
          format: int32
        b:
          type: integer
          format: int32
        a:
          type: number
          format: float
      additionalProperties: false
    LibraryDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/LibraryType'
        lastScanned:
          type: string
          format: date-time
        coverImage:
          type:
          - string
          - 'null'
        folderWatchMode:
          $ref: '#/components/schemas/FolderWatchMode'
        includeInDashboard:
          type: boolean
        includeInRecommended:
          type: boolean
        manageCollections:
          type: boolean
        manageReadingLists:
          type: boolean
        includeInSearch:
          type: boolean
        allowScrobbling:
          type: boolean
        folders:
          type:
          - array
          - 'null'
          items:
            type: string
        collapseSeriesRelationships:
          type: boolean
        libraryFileTypes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FileTypeGroup'
        excludePatterns:
          type:
          - array
          - 'null'
          items:
            type: string
        allowMetadataMatching:
          type: boolean
        enableMetadata:
          type: boolean
        removePrefixForSortName:
          type: boolean
        inheritWebLinksFromFirstChapter:
          type: boolean
        defaultLanguage:
          type:
          - string
          - 'null'
        metadataProvider:
          $ref: '#/components/schemas/MetadataProvider'
      additionalProperties: false
    LibraryType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      description: 'Members:

        - `0` — Manga

        - `1` — Comic (Flexible) (Comic)

        - `2` — Book

        - `3` — Image

        - `4` — Light Novel (LightNovel)

        - `5` — Comic (ComicVine)'
      format: int32
      x-enum-varnames:
      - Manga
      - Comic
      - Book
      - Image
      - LightNovel
      - ComicVine
      x-enum-descriptions:
      - Manga
      - Comic (Flexible)
      - Book
      - Image
      - Light Novel
      - Comic
    AppUserSocialPreferences:
      type: object
      properties:
        shareReviews:
          type: boolean
        shareAnnotations:
          type: boolean
        viewOtherAnnotations:
          type: boolean
        socialLibraries:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        socialMaxAgeRating:
          $ref: '#/components/schemas/AgeRating'
        socialIncludeUnknowns:
          type: boolean
        shareProfile:
          type: boolean
      additionalProperties: false
    AgeRating:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - -1
      type: integer
      description: 'Members:

        - `0` — Unknown

        - `1` — Rating Pending (RatingPending)

        - `2` — Early Childhood (EarlyChildhood)

        - `3` — Everyone

        - `4` — G

        - `5` — Everyone 10+ (Everyone10Plus)

        - `6` — PG

        - `7` — Kids to Adults (KidsToAdults)

        - `8` — Teen

        - `9` — MA15+ (Mature15Plus)

        - `10` — Mature 17+ (Mature17Plus)

        - `11` — M (Mature)

        - `12` — R18+ (R18Plus)

        - `13` — Adults Only 18+ (AdultsOnly)

        - `14` — X18+ (X18Plus)

        - `-1` — Not Applicable (NotApplicable)'
      format: int32
      x-enum-varnames:
      - Unknown
      - RatingPending
      - EarlyChildhood
      - Everyone
      - G
      - Everyone10Plus
      - PG
      - KidsToAdults
      - Teen
      - Mature15Plus
      - Mature17Plus
      - Mature
      - R18Plus
      - AdultsOnly
      - X18Plus
      - NotApplicable
      x-enum-descriptions:
      - Unknown
      - Rating Pending
      - Early Childhood
      - Everyone
      - G
      - Everyone 10+
      - PG
      - Kids to Adults
      - Teen
      - MA15+
      - Mature 17+
      - M
      - R18+
      - Adults Only 18+
      - X18+
      - Not Applicable
    KeyBind:
      required:
      - key
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        control:
          type: boolean
        shift:
          type: boolean
        meta:
          type: boolean
        alt:
          type: boolean
        controllerSequence:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    UserTokenInfoDto:
      type: object
      properties:
        userId:
          type: integer
          format: int32
        username:
          type:
          - string
          - 'null'
        tokens:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TokenValidityInfoDto'
      additionalProperties: false
    ScrobbleProvider:
      enum:
      - 0
      - 1
      - 2
      - 4
      - 5
      - 6
      type: integer
      description: 'Members:

        - `0` — Kavita

        - `1` — AniList

        - `2` — Mal

        - `4` — Cbr

        - `5` — Hardcover

        - `6` — MangaBaka'
      format: int32
      x-enum-varnames:
      - Kavita
      - AniList
      - Mal
      - Cbr
      - Hardcover
      - MangaBaka
      x-enum-descriptions:
      - Kavita
      - AniList
      - Mal
      - Cbr
      - Hardcover
      - MangaBaka
    TokenValidityInfoDto:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/ScrobbleProvider'
        validUntilUtc:
          type: string
          format: date-time
      additionalProperties: false
    FolderWatchMode:
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
      description: 'Members:

        - `0` — Off

        - `1` — Automatic

        - `2` — File Watcher (FileWatcher)

        - `3` — Polling'
      format: int32
      x-enum-varnames:
      - 'Off'
      - Automatic
      - FileWatcher
      - Polling
      x-enum-descriptions:
      - 'Off'
      - Automatic
      - File Watcher
      - Polling
    SiteThemeDto:
      required:
      - fileName
      - name
      - normalizedName
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        normalizedName:
          type:
          - string
          - 'null'
        fileName:
          type:
          - string
          - 'null'
        isDefault:
          type: boolean
        provider:
          $ref: '#/components/schemas/ThemeProvider'
        previewUrls:
          type:
          - array
          - 'null'
          items:
            type: string
        description:
          type:
          - string
          - 'null'
        author:
          type:
          - string
          - 'null'
        compatibleVersion:
          type:
          - string
          - 'null'
        selector:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    MemberDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
        username:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        isPending:
          type: boolean
        ageRestriction:
          $ref: '#/components/schemas/AgeRestrictionDto'
        created:
          type: string
          format: date-time
        createdUtc:
          type: string
          format: date-time
        lastActive:
          type: string
          format: date-time
        lastActiveUtc:
          type: string
          format: date-time
        libraries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LibraryDto'
        roles:
          type:
          - array
          - 'null'
          items:
            type: string
        identityProvider:
          $ref: '#/components/schemas/IdentityProvider'
      additionalProperties: false
    AgeRestrictionDto:
      required:
      - ageRating
      - includeUnknowns
      type: object
      properties:
        ageRating:
          $ref: '#/components/schemas/AgeRating'
        includeUnknowns:
          type: boolean
      additionalProperties: false
    MetadataProvider:
      enum:
      - 2
      - 3
      - 4
      type: integer
      description: 'Members:

        - `2` — Hardcover

        - `3` — Mangabaka

        - `4` — ComicBookRoundup'
      format: int32
      x-enum-varnames:
      - Hardcover
      - Mangabaka
      - ComicBookRoundup
      x-enum-descriptions:
      - Hardcover
      - Mangabaka
      - ComicBookRoundup
    MemberInfoDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
        username:
          type:
          - string
          - 'null'
        created:
          type: string
          format: date-time
        createdUtc:
          type: string
          format: date-time
        coverImage:
          type:
          - string
          - 'null'
      additionalProperties: false
    IdentityProvider:
      enum:
      - 0
      - 1
      type: integer
      description: 'Members:

        - `0` — Kavita

        - `1` — OpenID Connect (OpenIdConnect)'
      format: int32
      x-enum-varnames:
      - Kavita
      - OpenIdConnect
      x-enum-descriptions:
      - Kavita
      - OpenID Connect
    UserPreferencesDto:
      required:
      - blurUnreadSummaries
      - bookReaderHighlightSlots
      - collapseSeriesRelationships
      - colorScapeEnabled
      - customKeyBinds
      - dataSaver
      - locale
      - noTransitions
      - onDeckProgressDays
      - onDeckUpdateDays
      - opdsPreferences
      - promptForDownloadSize
      - promptForRereadsAfter
      - socialPreferences
      - theme
      type: object
      properties:
        theme:
          $ref: '#/components/schemas/SiteThemeDto'
        globalPageLayoutMode:
          $ref: '#/components/schemas/PageLayoutMode'
        blurUnreadSummaries:
          type: boolean
        promptForDownloadSize:
          type: boolean
        noTransitions:
          type: boolean
        collapseSeriesRelationships:
          type: boolean
        locale:
          minLength: 1
          type: string
        colorScapeEnabled:
          type: boolean
        dataSaver:
          type: boolean
        promptForRereadsAfter:
          type: integer
          format: int32
        onDeckProgressDays:
          type: integer
          format: int32
        onDeckUpdateDays:
          type: integer
          format: int32
        customKeyBinds:
          type: object
          properties:
            NavigateToSettings:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            OpenSearch:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            NavigateToScrobbling:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            ToggleFullScreen:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            BookmarkPage:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            OpenHelp:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            GoTo:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            ToggleMenu:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            PageLeft:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            PageRight:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            Escape:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            PageUp:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            PageDown:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            OffsetDoublePage:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            NextChapter:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            PreviousChapter:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            FirstPage:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            LastPage:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            NavigateHome:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
            OpenEventWidget:
              type: array
              items:
                $ref: '#/components/schemas/KeyBind'
          additionalProperties: false
        aniListScrobblingEnabled:
          type: boolean
        wantToReadSync:
          type: boolean
        bookReaderHighlightSlots:
          type: array
          items:
            $ref: '#/components/schemas/HighlightSlot'
        socialPreferences:
          $ref: '#/components/schemas/AppUserSocialPreferences'
        opdsPreferences:
          $ref: '#/components/schemas/AppUserOpdsPreferences'
      additionalProperties: false
    ThemeProvider:
      enum:
      - 1
      - 2
      type: integer
      description: 'Members:

        - `1` — System

        - `2` — Custom'
      format: int32
      x-enum-varnames:
      - System
      - Custom
      x-enum-descriptions:
      - System
      - Custom
    FileTypeGroup:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: 'Members:

        - `1` — Archive

        - `2` — EPub (Epub)

        - `3` — Pdf

        - `4` — Images'
      format: int32
      x-enum-varnames:
      - Archive
      - Epub
      - Pdf
      - Images
      x-enum-descriptions:
      - Archive
      - EPub
      - Pdf
      - Images
    HighlightSlot:
      type: object
      properties:
        id:
          type: integer
          format: int32
        slotNumber:
          type: integer
          format: int32
        color:
          $ref: '#/components/schemas/RgbaColor'
      additionalProperties: false
  securitySchemes:
    AuthKey:
      type: apiKey
      description: Auth Key authentication. Enter your Auth key from your user settings
      name: x-api-key
      in: header