Skip to content

Get a shelf by ID

GET
/api/v1/shelves/{shelfId}
curl --request GET \
--url http://127.0.0.1:58259/api/v1/shelves/1

Retrieve details of a specific shelf by its ID.

shelfId
required
integer format: int64

ID of the shelf

Shelf details returned successfully

Media type */*
object
id
integer format: int64
name
string
icon
string
iconType
string
Allowed values: PRIME_NG CUSTOM_SVG
sort
object
field
string
direction
string
Allowed values: ASCENDING DESCENDING
userId
integer format: int64
publicShelf
boolean
bookCount
integer format: int32

Forbidden

Media type */*
object
id
integer format: int64
name
string
icon
string
iconType
string
Allowed values: PRIME_NG CUSTOM_SVG
sort
object
field
string
direction
string
Allowed values: ASCENDING DESCENDING
userId
integer format: int64
publicShelf
boolean
bookCount
integer format: int32