Skip to content

List app books

GET
/api/v1/app/books
curl --request GET \
--url 'http://127.0.0.1:58259/api/v1/app/books?page=1&size=1&sort=example&dir=example&libraryId=1&shelfId=1&status=%5B%22example%22%5D&search=example&fileType=%5B%22example%22%5D&minRating=1&maxRating=1&authors=%5B%22example%22%5D&language=%5B%22example%22%5D&series=%5B%22example%22%5D&category=%5B%22example%22%5D&publisher=%5B%22example%22%5D&tag=%5B%22example%22%5D&mood=%5B%22example%22%5D&narrator=%5B%22example%22%5D&ageRating=%5B%22example%22%5D&contentRating=%5B%22example%22%5D&matchScore=%5B%22example%22%5D&publishedDate=%5B%22example%22%5D&fileSize=%5B%22example%22%5D&personalRating=%5B%22example%22%5D&amazonRating=%5B%22example%22%5D&goodreadsRating=%5B%22example%22%5D&hardcoverRating=%5B%22example%22%5D&lubimyczytacRating=%5B%22example%22%5D&ranobedbRating=%5B%22example%22%5D&audibleRating=%5B%22example%22%5D&pageCount=%5B%22example%22%5D&shelfStatus=%5B%22example%22%5D&comicCharacter=%5B%22example%22%5D&comicTeam=%5B%22example%22%5D&comicLocation=%5B%22example%22%5D&comicCreator=%5B%22example%22%5D&shelves=%5B%22example%22%5D&libraries=%5B%22example%22%5D&magicShelfId=1&unshelved=true&filterMode=example'

Retrieve paginated books for the app with optional filtering and sorting.

request
required
object
page
integer format: int32
size
integer format: int32
sort
string
dir
string
libraryId
integer format: int64
shelfId
integer format: int64
status
Array<string>
0 <= 20 items
search
string
fileType
Array<string>
0 <= 20 items
minRating
integer format: int32
maxRating
integer format: int32
authors
Array<string>
0 <= 20 items
language
Array<string>
0 <= 20 items
series
Array<string>
0 <= 20 items
category
Array<string>
0 <= 20 items
publisher
Array<string>
0 <= 20 items
tag
Array<string>
0 <= 20 items
mood
Array<string>
0 <= 20 items
narrator
Array<string>
0 <= 20 items
ageRating
Array<string>
0 <= 20 items
contentRating
Array<string>
0 <= 20 items
matchScore
Array<string>
0 <= 20 items
publishedDate
Array<string>
0 <= 20 items
fileSize
Array<string>
0 <= 20 items
personalRating
Array<string>
0 <= 20 items
amazonRating
Array<string>
0 <= 20 items
goodreadsRating
Array<string>
0 <= 20 items
hardcoverRating
Array<string>
0 <= 20 items
lubimyczytacRating
Array<string>
0 <= 20 items
ranobedbRating
Array<string>
0 <= 20 items
audibleRating
Array<string>
0 <= 20 items
pageCount
Array<string>
0 <= 20 items
shelfStatus
Array<string>
0 <= 20 items
comicCharacter
Array<string>
0 <= 20 items
comicTeam
Array<string>
0 <= 20 items
comicLocation
Array<string>
0 <= 20 items
comicCreator
Array<string>
0 <= 20 items
shelves
Array<string>
0 <= 20 items
libraries
Array<string>
0 <= 20 items
magicShelfId
integer format: int64
unshelved
boolean
filterMode
string

OK

Media type */*
object
content
Array<object>
object
id
integer format: int64
title
string
authors
Array<string>
thumbnailUrl
string
readStatus
string
personalRating
integer format: int32
seriesName
string
seriesNumber
number format: float
libraryId
integer format: int64
addedOn
string format: date-time
lastReadTime
string format: date-time
readProgress
number format: float
primaryFileId
integer format: int64
primaryFileType
string
primaryFileName
string
coverUpdatedOn
string format: date-time
audiobookCoverUpdatedOn
string format: date-time
isPhysical
boolean
publisher
string
categories
Array<string>
tags
Array<string>
moods
Array<string>
language
string
narrator
string
isbn13
string
isbn10
string
publishedDate
string format: date
pageCount
integer format: int32
ageRating
integer format: int32
contentRating
string
metadataMatchScore
number format: float
fileSizeKb
integer format: int64
amazonRating
number format: double
amazonReviewCount
integer format: int32
goodreadsRating
number format: double
goodreadsReviewCount
integer format: int32
hardcoverRating
number format: double
hardcoverReviewCount
integer format: int32
ranobedbRating
number format: double
lubimyczytacRating
number format: double
audibleRating
number format: double
audibleReviewCount
integer format: int32
allMetadataLocked
boolean
page
integer format: int32
size
integer format: int32
totalElements
integer format: int64
totalPages
integer format: int32
hasNext
boolean
hasPrevious
boolean