Skip to content

Get inbox book

GET
/api/inbox/{id}

Retrieve a single inbox/review book with its files and metadata candidates

Parameters

Path Parameters

id*

Book UUID

Type
string
Required
Format
"uuid"

Responses

Book with files and candidates

application/json
JSON
{
  
"id": "string",
  
"status": "string",
  
"title": "string",
  
"author": "string",
  
"isbn10": "string",
  
"isbn13": "string",
  
"publisher": "string",
  
"publishedYear": 0,
  
"language": "string",
  
"description": "string",
  
"coverUrl": "string",
  
"coverPath": "string",
  
"pageCount": 0,
  
"series": "string",
  
"seriesIndex": 0,
  
"genres": [
  
  
"string"
  
],
  
"tags": [
  
  
"string"
  
],
  
"hardcoverBookId": 0,
  
"hardcoverEditionId": 0,
  
"createdBy": "string",
  
"possibleDuplicateOf": "string",
  
"approvedAt": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"possibleDuplicate": {
  
  
"id": "string",
  
  
"title": "string",
  
  
"author": "string",
  
  
"status": "string"
  
},
  
"files": [
  
  
{
  
  
  
"id": "string",
  
  
  
"format": "string",
  
  
  
"originalName": "string",
  
  
  
"fileSize": "string",
  
  
  
"inboxPath": "string",
  
  
  
"checksum": "string"
  
  
}
  
],
  
"candidates": [
  
  
{
  
  
  
"id": "string",
  
  
  
"source": "string",
  
  
  
"normalized": "string",
  
  
  
"confidence": "string",
  
  
  
"selectedFields": [
  
  
  
  
"string"
  
  
  
]
  
  
}
  
],
  
"uploader": {
  
  
"id": "string",
  
  
"label": "string"
  
}
}

Samples