PaginatedResponse_FullSeriesResponse

Generic paginated response wrapper with HATEOAS links

data object[]required

The data items for this page

Array [

alternateTitles object[]required

Alternate titles for this series

Array [

createdAtstring<date-time>required

When the title was created

Example: 2024-01-01T00:00:00Z

idstring<uuid>required

Alternate title ID

Example: 550e8400-e29b-41d4-a716-446655440040

labelstringrequired

Label for this title (e.g., "Japanese", "Romaji", "English", "Korean")

Example: Japanese

seriesIdstring<uuid>required

Series ID

Example: 550e8400-e29b-41d4-a716-446655440002

titlestringrequired

The alternate title

Example: 進撃の巨人

updatedAtstring<date-time>required

When the title was last updated

Example: 2024-01-15T10:30:00Z

]

bookCountinteger<int64>required

Total number of books in this series

Example: 4

createdAtstring<date-time>required

When the series was created

Example: 2024-01-01T00:00:00Z

externalIds object[]required

External IDs from metadata providers (plugins, comicinfo, etc.)

Array [

createdAtstring<date-time>required

When the external ID was created

Example: 2024-01-01T00:00:00Z

externalIdstringrequired

External ID value from the source

Example: 12345

externalUrlstring | nullnullable

URL to the external source (if available)

Example: https://mangabaka.com/manga/12345

idstring<uuid>required

External ID record ID

Example: 550e8400-e29b-41d4-a716-446655440070

lastSyncedAt(string | null)<date-time>nullable

When the metadata was last synced from this source

Example: 2024-01-15T10:30:00Z

metadataHashstring | nullnullable

Hash of the last fetched metadata (for change detection)

seriesIdstring<uuid>required

Series ID

Example: 550e8400-e29b-41d4-a716-446655440002

sourcestringrequired

Source identifier (e.g., "plugin:mangabaka", "comicinfo", "epub")

Example: plugin:mangabaka

updatedAtstring<date-time>required

When the external ID was last updated

Example: 2024-01-15T10:30:00Z

]

externalLinks object[]required

External links to other sites

Array [

createdAtstring<date-time>required

When the link was created

Example: 2024-01-01T00:00:00Z

externalIdstring | nullnullable

ID on the external source (if available)

Example: 12345

idstring<uuid>required

External link ID

Example: 550e8400-e29b-41d4-a716-446655440060

seriesIdstring<uuid>required

Series ID

Example: 550e8400-e29b-41d4-a716-446655440002

sourceNamestringrequired

Source name (e.g., "myanimelist", "anilist", "mangadex")

Example: myanimelist

updatedAtstring<date-time>required

When the link was last updated

Example: 2024-01-15T10:30:00Z

urlstringrequired

URL to the external source

Example: https://myanimelist.net/manga/12345

]

externalRatings object[]required

External ratings from various sources

Array [

createdAtstring<date-time>required

When the rating record was created

Example: 2024-01-01T00:00:00Z

fetchedAtstring<date-time>required

When the rating was last fetched from the source

Example: 2024-01-15T10:30:00Z

idstring<uuid>required

External rating ID

Example: 550e8400-e29b-41d4-a716-446655440050

ratingnumber<double>required

Rating value (0-100)

Example: 85.5

seriesIdstring<uuid>required

Series ID

Example: 550e8400-e29b-41d4-a716-446655440002

sourceNamestringrequired

Source name (e.g., "myanimelist", "anilist", "mangabaka")

Example: myanimelist

updatedAtstring<date-time>required

When the rating record was last updated

Example: 2024-01-15T10:30:00Z

voteCount(integer | null)<int32>nullable

Number of votes (if available)

Example: 12500

]

genres object[]required

Genres assigned to this series

Array [

createdAtstring<date-time>required

When the genre was created

Example: 2024-01-01T00:00:00Z

idstring<uuid>required

Genre ID

Example: 550e8400-e29b-41d4-a716-446655440010

namestringrequired

Genre name

Example: Action

seriesCount(integer | null)<int64>nullable

Number of series with this genre

Possible values: >= 0

Example: 42

]

hasCustomCoverboolean | nullnullable

Whether the series has a custom cover uploaded

Example: false

idstring<uuid>required

Series unique identifier

Example: 550e8400-e29b-41d4-a716-446655440002

lastCompletedAt(string | null)<date-time>nullable

When the requesting user most recently completed the whole series, or null if never.

Example: 2024-01-14T20:05:00Z

libraryIdstring<uuid>required

Library unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000

libraryNamestringrequired

Name of the library this series belongs to

Example: Comics

localMaxChapter(number | null)<float>nullable

Highest book_metadata.chapter across the books in this series. See SeriesDto::local_max_chapter for semantics.

Example: 137.5

localMaxVolume(integer | null)<int32>nullable

Highest book_metadata.volume across the books in this series. See SeriesDto::local_max_volume for semantics.

Example: 14

metadata objectrequired

Complete series metadata

ageRating(integer | null)<int32>nullable

Age rating (e.g., 13, 16, 18)

Example: 16

authors object[]

Structured author information

Array [

namestringrequired

Author's name

Example: Andy Weir

roleBookAuthorRolerequired

Role of this author

Possible values: [author, co_author, editor, translator, illustrator, contributor, writer, penciller, inker, colorist, letterer, cover_artist]

sortNamestring | nullnullable

Sort name for ordering (e.g., "Weir, Andy")

Example: Weir, Andy

]

createdAtstring<date-time>required

When the metadata was created

Example: 2024-01-01T00:00:00Z

customMetadataobject | nullnullable

Custom JSON metadata

imprintstring | nullnullable

Imprint (sub-publisher)

Example: Vertigo

languagestring | nullnullable

Language (BCP47 format: "en", "ja", "ko")

Example: en

locks objectrequired

Lock states for all metadata fields

ageRatingbooleanrequired

Whether the age_rating field is locked

Example: false

alternateTitlesbooleanrequired

Whether the alternate titles are locked

Example: false

authorsJsonLockbooleanrequired

Whether the authors_json field is locked

Example: false

coverbooleanrequired

Whether the cover selection is locked When locked, plugins can still download covers but won't auto-select them

Example: false

customMetadatabooleanrequired

Whether the custom_metadata field is locked

Example: false

genresbooleanrequired

Whether the genres are locked

Example: false

imprintbooleanrequired

Whether the imprint field is locked

Example: false

languagebooleanrequired

Whether the language field is locked

Example: false

publisherbooleanrequired

Whether the publisher field is locked

Example: false

readingDirectionbooleanrequired

Whether the reading_direction field is locked

Example: false

statusbooleanrequired

Whether the status field is locked

Example: false

summarybooleanrequired

Whether the summary field is locked

Example: true

tagsbooleanrequired

Whether the tags are locked

Example: false

titlebooleanrequired

Whether the title field is locked

Example: false

titleSortbooleanrequired

Whether the title_sort field is locked

Example: false

totalChapterCountbooleanrequired

Whether the total_chapter_count field is locked

Example: false

totalVolumeCountbooleanrequired

Whether the total_volume_count field is locked

Example: false

yearbooleanrequired

Whether the year field is locked

Example: false

publisherstring | nullnullable

Publisher name

Example: DC Comics

readingDirectionstring | nullnullable

Reading direction (ltr, rtl, ttb or webtoon)

Example: ltr

statusstring | nullnullable

Series status (ongoing, ended, hiatus, abandoned, unknown)

Example: ended

summarystring | nullnullable

Series description/summary

Example: The definitive origin story of Batman.

titlestringrequired

Series title

Example: Batman: Year One

titleSortstring | nullnullable

Custom sort name for ordering

Example: Batman Year One

totalChapterCount(number | null)<float>nullable

Expected total chapter count (for chapter-organized series). May be fractional.

Example: 109.5

totalVolumeCount(integer | null)<int32>nullable

Expected total volume count (for volume-organized series).

Example: 4

updatedAtstring<date-time>required

When the metadata was last updated

Example: 2024-01-15T10:30:00Z

year(integer | null)<int32>nullable

Release year

Example: 1987

pathstring | nullnullable

Filesystem path to the series directory

Example: /media/comics/Batman - Year One

readCountinteger<int64>required

How many times the requesting user has completed the whole series.

The minimum completion count across its books: the series counts as read N times only once every volume has been read N times. A series with no books reports 0. Adding a new volume to a finished series therefore drops this to 0, which is correct; the per-pass history remains visible.

Example: 1

selectedCoverSourcestring | nullnullable

Selected cover source (e.g., "first_book", "custom")

Example: first_book

tags object[]required

Tags assigned to this series

Array [

createdAtstring<date-time>required

When the tag was created

Example: 2024-01-01T00:00:00Z

idstring<uuid>required

Tag ID

Example: 550e8400-e29b-41d4-a716-446655440020

namestringrequired

Tag name

Example: Completed

seriesCount(integer | null)<int64>nullable

Number of series with this tag

Possible values: >= 0

Example: 15

]

trackedbooleanrequired

Whether release tracking is enabled for this series. See SeriesDto::tracked.

Example: false

unreadCount(integer | null)<int64>nullable

Number of unread books in this series (user-specific)

Example: 2

updatedAtstring<date-time>required

When the series was last updated

Example: 2024-01-15T10:30:00Z

upstreamChapterGap(number | null)<float>nullable

Upstream-vs-local chapter delta. See SeriesDto::upstream_chapter_gap.

Example: 3

upstreamGapProviderstring | nullnullable

Provider that supplied the upstream counts. See SeriesDto::upstream_gap_provider.

Example: MangaBaka

upstreamVolumeGap(integer | null)<int32>nullable

Upstream-vs-local volume delta. See SeriesDto::upstream_volume_gap.

Example: 1

volumesOwned(integer | null)<int64>nullable

Number of books classified as a complete volume (volume set, chapter null). See SeriesDto::volumes_owned for semantics.

Example: 14

wantToReadboolean | nullnullable

Whether the requesting user has this series in their want-to-read queue.

Example: false

]

links objectrequired

HATEOAS navigation links

firststringrequired

Link to the first page

laststringrequired

Link to the last page

nextstring | nullnullable

Link to the next page (null if on last page)

prevstring | nullnullable

Link to the previous page (null if on first page)

selfstringrequired

Link to the current page

pageinteger<int64>required

Current page number (1-indexed)

Possible values: >= 0

Example: 1

pageSizeinteger<int64>required

Number of items per page

Possible values: >= 0

Example: 50

totalinteger<int64>required

Total number of items across all pages

Possible values: >= 0

Example: 150

totalPagesinteger<int64>required

Total number of pages

Possible values: >= 0

Example: 3

PaginatedResponse_FullSeriesResponse

{
  "data": [
    {
      "alternateTitles": [
        {
          "createdAt": "2024-01-01T00:00:00Z",
          "id": "550e8400-e29b-41d4-a716-446655440040",
          "label": "Japanese",
          "seriesId": "550e8400-e29b-41d4-a716-446655440002",
          "title": "進撃の巨人",
          "updatedAt": "2024-01-15T10:30:00Z"
        }
      ],
      "bookCount": 4,
      "createdAt": "2024-01-01T00:00:00Z",
      "externalIds": [
        {
          "createdAt": "2024-01-01T00:00:00Z",
          "externalId": "12345",
          "externalUrl": "https://mangabaka.com/manga/12345",
          "id": "550e8400-e29b-41d4-a716-446655440070",
          "lastSyncedAt": "2024-01-15T10:30:00Z",
          "metadataHash": "string",
          "seriesId": "550e8400-e29b-41d4-a716-446655440002",
          "source": "plugin:mangabaka",
          "updatedAt": "2024-01-15T10:30:00Z"
        }
      ],
      "externalLinks": [
        {
          "createdAt": "2024-01-01T00:00:00Z",
          "externalId": "12345",
          "id": "550e8400-e29b-41d4-a716-446655440060",
          "seriesId": "550e8400-e29b-41d4-a716-446655440002",
          "sourceName": "myanimelist",
          "updatedAt": "2024-01-15T10:30:00Z",
          "url": "https://myanimelist.net/manga/12345"
        }
      ],
      "externalRatings": [
        {
          "createdAt": "2024-01-01T00:00:00Z",
          "fetchedAt": "2024-01-15T10:30:00Z",
          "id": "550e8400-e29b-41d4-a716-446655440050",
          "rating": 85.5,
          "seriesId": "550e8400-e29b-41d4-a716-446655440002",
          "sourceName": "myanimelist",
          "updatedAt": "2024-01-15T10:30:00Z",
          "voteCount": 12500
        }
      ],
      "genres": [
        {
          "createdAt": "2024-01-01T00:00:00Z",
          "id": "550e8400-e29b-41d4-a716-446655440010",
          "name": "Action",
          "seriesCount": 42
        }
      ],
      "hasCustomCover": false,
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "lastCompletedAt": "2024-01-14T20:05:00Z",
      "libraryId": "550e8400-e29b-41d4-a716-446655440000",
      "libraryName": "Comics",
      "localMaxChapter": 137.5,
      "localMaxVolume": 14,
      "metadata": {
        "ageRating": 16,
        "authors": "Unknown Type: array,null",
        "createdAt": "2024-01-01T00:00:00Z",
        "customMetadata": "Unknown Type: object,null",
        "imprint": "Vertigo",
        "language": "en",
        "locks": {
          "ageRating": false,
          "alternateTitles": false,
          "authorsJsonLock": false,
          "cover": false,
          "customMetadata": false,
          "genres": false,
          "imprint": false,
          "language": false,
          "publisher": false,
          "readingDirection": false,
          "status": false,
          "summary": true,
          "tags": false,
          "title": false,
          "titleSort": false,
          "totalChapterCount": false,
          "totalVolumeCount": false,
          "year": false
        },
        "publisher": "DC Comics",
        "readingDirection": "ltr",
        "status": "ended",
        "summary": "The definitive origin story of Batman.",
        "title": "Batman: Year One",
        "titleSort": "Batman Year One",
        "totalChapterCount": 109.5,
        "totalVolumeCount": 4,
        "updatedAt": "2024-01-15T10:30:00Z",
        "year": 1987
      },
      "path": "/media/comics/Batman - Year One",
      "readCount": 1,
      "selectedCoverSource": "first_book",
      "tags": [
        {
          "createdAt": "2024-01-01T00:00:00Z",
          "id": "550e8400-e29b-41d4-a716-446655440020",
          "name": "Completed",
          "seriesCount": 15
        }
      ],
      "tracked": false,
      "unreadCount": 2,
      "updatedAt": "2024-01-15T10:30:00Z",
      "upstreamChapterGap": 3,
      "upstreamGapProvider": "MangaBaka",
      "upstreamVolumeGap": 1,
      "volumesOwned": 14,
      "wantToRead": false
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "page": 1,
  "pageSize": 50,
  "total": 150,
  "totalPages": 3
}