Skip to content

Get all libraries

GET
/api/v1/libraries
curl --request GET \
--url http://127.0.0.1:58259/api/v1/libraries

Retrieve a list of all libraries.

Libraries returned successfully

Media type */*
Array<object>
object
id
integer format: int64
name
string
sort
object
field
string
direction
string
Allowed values: ASCENDING DESCENDING
icon
string
iconType
string
Allowed values: PRIME_NG CUSTOM_SVG
fileNamingPattern
string
watch
boolean
paths
Array<object>
object
id
integer format: int64
libraryId
integer format: int64
path
string
formatPriority
Array<string>
Allowed values: PDF EPUB CBX FB2 MOBI AZW3 AUDIOBOOK
allowedFormats
Array<string>
Allowed values: PDF EPUB CBX FB2 MOBI AZW3 AUDIOBOOK
organizationMode
string
Allowed values: BOOK_PER_FILE BOOK_PER_FOLDER AUTO_DETECT
metadataSource
string
Allowed values: EMBEDDED SIDECAR PREFER_SIDECAR PREFER_EMBEDDED NONE