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
Minimum
1
Default
1
limit

Number of items per page

Type
integer
Minimum
1
Maximum
100
Default
20
sort

Sort field

Type
string
Default
"title"
order

Sort direction

Type
string
Default
"asc"
search

Full-text search query

Type
string
Max Length
500
Default
""

Responses​

Paginated list of books with reading progress

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"title": "string",
  
  
  
"author": "string",
  
  
  
"coverPath": "string",
  
  
  
"isbn13": "string",
  
  
  
"isbn10": "string",
  
  
  
"genres": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"pageCount": 0,
  
  
  
"percentage": 0,
  
  
  
"device": "string",
  
  
  
"lastReadAt": "string",
  
  
  
"readingStatus": "string"
  
  
}
  
],
  
"pagination": {
  
  
"page": 0,
  
  
"limit": 0,
  
  
"total": 0,
  
  
"totalPages": 0
  
}
}

Samples​