Series
Series browsing and search endpoints
List series in a specific library with pagination
List series in a specific library with pagination
List in-progress series in a specific library
List in-progress series in a specific library
List recently added series in a specific library
List recently added series in a specific library
List recently updated series in a specific library
List recently updated series in a specific library
List series with optional library filter and pagination
List series with optional library filter and pagination
Slim external-index projection of every visible series
Returns one entry per series the caller can access, carrying only the
List series with their metadata, genres, tags and external links
The same page `GET /api/v1/series` returns, with each entry carrying the
List series with in-progress books (series that have at least one book with reading progress that is not completed)
List series with in-progress books (series that have at least one book with reading progress that is not completed)
List series with advanced filtering
Supports complex filter conditions including nested AllOf/AnyOf logic,
Get alphabetical groups for series
Returns a list of alphabetical groups with counts, showing how many series
List recently added series
List recently added series
List recently updated series
List recently updated series
Search series by name
Search series by name
Get series by ID
Get series by ID
Update series core fields (name/title)
Partially updates series_metadata fields. Only provided fields will be updated.
Get alternate titles for a series
Get alternate titles for a series
Add an alternate title to a series
Add an alternate title to a series
Delete an alternate title
Delete an alternate title
Update an alternate title
Update an alternate title
Get books in a series
Get books in a series
Upload a custom cover/poster for a series
Upload a custom cover/poster for a series
Set which cover source to use for a series (partial update)
Set which cover source to use for a series (partial update)
List all covers for a series
List all covers for a series
Reset series cover to default (deselect all custom covers)
Reset series cover to default (deselect all custom covers)
Delete a cover from a series
Delete a cover from a series
Get a specific cover image for a series
Supports HTTP conditional caching with ETag and Last-Modified headers,
Select a cover as the primary cover for a series
Select a cover as the primary cover for a series
Download all books in a series as a zip file
Creates a zip archive containing all detected books in the series.
List all external IDs for a series
List all external IDs for a series
Create or update an external ID for a series
Upserts by series_id + source: if an external ID with the same source already exists,
Delete an external ID from a series
Delete an external ID from a series
Get external links for a series
Get external links for a series
Add or update an external link for a series
Add or update an external link for a series
Delete an external link by ID
Delete an external link by ID
Get external ratings for a series
Get external ratings for a series
Add or update an external rating for a series
Add or update an external rating for a series
Delete an external rating by source name
Delete an external rating by source name
Get a series with its metadata, genres, tags and external links in one response
The same series `GET /api/v1/series/{series_id}` returns, plus the related
Get series metadata including all related data
Returns comprehensive metadata with lock states, genres, tags, alternate titles,
Replace all series metadata (PUT)
Replaces all metadata fields with the values in the request.
Reset series metadata to filesystem-derived defaults
Completely resets all series metadata back to original values derived from
Partially update series metadata (PATCH)
Only provided fields will be updated. Absent fields are unchanged.
Get metadata lock states
Get metadata lock states
Update metadata lock states
Sets which metadata fields are locked. Locked fields will not be overwritten
Purge deleted books from a series
Purge deleted books from a series
Get the average community rating for a series
Returns the average rating from all users and the total count of ratings.
Mark all books in a series as read
Mark all books in a series as read
Get thumbnail/cover image for a series
Get thumbnail/cover image for a series
Mark all books in a series as unread
Mark all books in a series as unread