/
KA
kareadita
/
Kavita
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 2d ago
View markdown
kareadita
Kavita
get
Returns all people in given roles for a reading list
latest
OpenAPI 3.0.4
GPL-3.0
raw.githubusercontent.com
2026-08-21
517
376
886.6 KB
06a131fe22cf
Account
28
Activity
1
Admin
1
Annotation
12
Book
4
Cbl
14
Chapter
5
Collection
12
ColorScape
3
Device
10
Download
12
Email
1
Filter
12
Font
5
Health
1
Image
15
KavitaPlusAudit
6
Koreader
3
Library
23
License
13
Locale
1
Manage
2
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
get
Fetches a single Reading List
delete
Deletes a reading list
post
Returns reading lists (paginated) for a given user.
post
Returns reading lists (paginated) for a given user.
get
Returns all Reading Lists the user has access to that the given series within it.
get
Returns all Reading Lists the user has access to that has the given chapter within it.
get
Fetches all reading list items for a given list including rich metadata around series, volume, chapters, and progress
post
Updates an items position
post
Deletes a list item from the list. Item orders will update as a result.
post
Removes all entries that are fully read from the reading list
post
Creates a new List with a unique title. Returns the new ReadingList back
post
Update the properties (title, summary) of a reading list
post
Adds all chapters from a Series to a reading list
post
Adds all chapters from a list of volumes and chapters to a reading list
post
Adds all chapters from a list of series to a reading list
post
/api/ReadingList/update-by-volume
post
/api/ReadingList/update-by-chapter
get
Returns a list of a given role associated with the reading list
get
Returns all people in given roles for a reading list
get
Returns the next chapter within the reading list
get
Returns the prev chapter within the reading list
get
Checks if a reading list exists with the name
post
Promote/UnPromote multiple reading lists in one go. Will only update the authenticated user's reading lists and will only work if the user has promotion role
post
Delete multiple reading lists in one go
get
Returns random information about a Reading List
post
Export a Reading List to CBL format
post
Regenerates the cover image for a reading list, you must own the given reading list to do this
ReadingProfile
16
Review
5
Scrobbling
19
Search
4
Series
33
Server
18
Settings
20
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
13
Users
10
Volume
4
WantToRead
4
ReadingList
Returns all people in given roles for a reading list
get
/api/ReadingList/all-people
Query parameters
readingListId
integer
Response
OK
PersonDto[]
required
id
integer
name
string
nullable
required
coverImageLocked
boolean
primaryColor
string
nullable
secondaryColor
string
nullable
coverImage
string
nullable
aliases
string[]
nullable
description
string
nullable
asin
string
nullable
aniListId
integer
malId
integer
hardcoverId
string
nullable
webLinks
string[]
nullable
roles
PersonRole[]
nullable