Libris

Appearance

List books by reading status​

GET
/api/reading-status/{status}

Returns a paginated list of organized books filtered by the given reading status, with optional search and sorting.

Parameters​

Path Parameters

status*

Reading status to filter by

Type
string
Required
Valid values
"unread""reading""finished""paused"

Query Parameters

page

Page number (1-based)

Type
integer
Default
1
perPage

Number of items per page

Type
integer
Default
20
Maximum
100
sort

Sort field

Type
string
Valid values
"title""author""percentage""lastRead"
Default
"title"
order

Sort direction

Type
string
Valid values
"asc""desc"
Default
"asc"
search

Full-text search query

Type
string

Responses​

Paginated list of books with reading progress

application/json
JSON
{
  
"books": [
  
  
{
  
  
  
"id": "string",
  
  
  
"title": "string",
  
  
  
"author": "string",
  
  
  
"coverPath": "string",
  
  
  
"genres": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"pageCount": 0,
  
  
  
"percentage": 0,
  
  
  
"device": "string",
  
  
  
"lastReadAt": "string",
  
  
  
"readingStatus": "string"
  
  
}
  
],
  
"total": 0,
  
"page": 0,
  
"perPage": 0
}

Samples​