Skip to content

List inbox books

GET
/api/inbox

Paginated list of books in inbox or review status

Parameters

Query Parameters

page
Type
integer
Default
1
limit
Type
integer
Default
20
Maximum
100
q

Search title, author, or description

Type
string
sort

Sort order for results

Type
string
Valid values
"title_asc""title_desc""detected_newest""detected_oldest""status_asc""status_desc"
Default
"detected_newest"

Responses

Paginated list of inbox books with files

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"author": "string",
  
  
  
"createdAt": "string",
  
  
  
"files": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"format": "string",
  
  
  
  
  
"originalName": "string",
  
  
  
  
  
"fileSize": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"pagination": {
  
  
"page": 0,
  
  
"limit": 0,
  
  
"total": 0,
  
  
"totalPages": 0
  
}
}

Samples