Skip to content

Get sidecar content

GET
/api/v1/books/{bookId}/sidecar
curl --request GET \
--url http://127.0.0.1:58259/api/v1/books/1/sidecar

Get the content of the sidecar JSON file for a book

bookId
required
integer format: int64

Book ID

Sidecar content returned successfully

Media type */*
object
version
string
generatedAt
string format: date-time
generatedBy
string
metadata
object
title
string
subtitle
string
authors
Array<string>
publisher
string
publishedDate
string format: date
description
string
isbn10
string
isbn13
string
language
string
pageCount
integer format: int32
categories
Array<string>
unique items
moods
Array<string>
unique items
tags
Array<string>
unique items
series
object
name
string
number
number format: float
total
integer format: int32
identifiers
object
asin
string
goodreadsId
string
googleId
string
hardcoverId
string
hardcoverBookId
string
comicvineId
string
lubimyczytacId
string
ranobedbId
string
audibleId
string
ratings
object
amazon
object
average
number format: double
count
integer format: int32
goodreads
object
average
number format: double
count
integer format: int32
hardcover
object
average
number format: double
count
integer format: int32
lubimyczytac
object
average
number format: double
count
integer format: int32
ranobedb
object
average
number format: double
count
integer format: int32
audible
object
average
number format: double
count
integer format: int32
ageRating
integer format: int32
contentRating
string
narrator
string
abridged
boolean
comicMetadata
object
issueNumber
string
volumeName
string
volumeNumber
integer format: int32
storyArc
string
storyArcNumber
integer format: int32
alternateSeries
string
alternateIssue
string
pencillers
Array<string>
unique items
inkers
Array<string>
unique items
colorists
Array<string>
unique items
letterers
Array<string>
unique items
coverArtists
Array<string>
unique items
editors
Array<string>
unique items
imprint
string
format
string
blackAndWhite
boolean
manga
boolean
readingDirection
string
characters
Array<string>
unique items
teams
Array<string>
unique items
locations
Array<string>
unique items
webLink
string
notes
string
issueNumberLocked
boolean
volumeNameLocked
boolean
volumeNumberLocked
boolean
storyArcLocked
boolean
storyArcNumberLocked
boolean
alternateSeriesLocked
boolean
alternateIssueLocked
boolean
imprintLocked
boolean
formatLocked
boolean
blackAndWhiteLocked
boolean
mangaLocked
boolean
readingDirectionLocked
boolean
webLinkLocked
boolean
notesLocked
boolean
creatorsLocked
boolean
pencillersLocked
boolean
inkersLocked
boolean
coloristsLocked
boolean
letterersLocked
boolean
coverArtistsLocked
boolean
editorsLocked
boolean
charactersLocked
boolean
teamsLocked
boolean
locationsLocked
boolean
cover
object
source
string
path
string

Book or sidecar file not found

Media type */*
object
version
string
generatedAt
string format: date-time
generatedBy
string
metadata
object
title
string
subtitle
string
authors
Array<string>
publisher
string
publishedDate
string format: date
description
string
isbn10
string
isbn13
string
language
string
pageCount
integer format: int32
categories
Array<string>
unique items
moods
Array<string>
unique items
tags
Array<string>
unique items
series
object
name
string
number
number format: float
total
integer format: int32
identifiers
object
asin
string
goodreadsId
string
googleId
string
hardcoverId
string
hardcoverBookId
string
comicvineId
string
lubimyczytacId
string
ranobedbId
string
audibleId
string
ratings
object
amazon
object
average
number format: double
count
integer format: int32
goodreads
object
average
number format: double
count
integer format: int32
hardcover
object
average
number format: double
count
integer format: int32
lubimyczytac
object
average
number format: double
count
integer format: int32
ranobedb
object
average
number format: double
count
integer format: int32
audible
object
average
number format: double
count
integer format: int32
ageRating
integer format: int32
contentRating
string
narrator
string
abridged
boolean
comicMetadata
object
issueNumber
string
volumeName
string
volumeNumber
integer format: int32
storyArc
string
storyArcNumber
integer format: int32
alternateSeries
string
alternateIssue
string
pencillers
Array<string>
unique items
inkers
Array<string>
unique items
colorists
Array<string>
unique items
letterers
Array<string>
unique items
coverArtists
Array<string>
unique items
editors
Array<string>
unique items
imprint
string
format
string
blackAndWhite
boolean
manga
boolean
readingDirection
string
characters
Array<string>
unique items
teams
Array<string>
unique items
locations
Array<string>
unique items
webLink
string
notes
string
issueNumberLocked
boolean
volumeNameLocked
boolean
volumeNumberLocked
boolean
storyArcLocked
boolean
storyArcNumberLocked
boolean
alternateSeriesLocked
boolean
alternateIssueLocked
boolean
imprintLocked
boolean
formatLocked
boolean
blackAndWhiteLocked
boolean
mangaLocked
boolean
readingDirectionLocked
boolean
webLinkLocked
boolean
notesLocked
boolean
creatorsLocked
boolean
pencillersLocked
boolean
inkersLocked
boolean
coloristsLocked
boolean
letterersLocked
boolean
coverArtistsLocked
boolean
editorsLocked
boolean
charactersLocked
boolean
teamsLocked
boolean
locationsLocked
boolean
cover
object
source
string
path
string