Skip to main content

KomgaPage_KomgaSeriesDto

Komga paginated response wrapper (Spring Data Page format)

This matches the exact structure Komic expects from Komga.

content object[]required

The content items for this page

  • Array [
  • booksCountinteger<int32>required

    Total books count

    booksInProgressCountinteger<int32>required

    In-progress books count

    booksMetadata objectrequired

    Aggregated books metadata

    authors object[]

    Authors from all books

  • Array [
  • namestringrequired

    Author name

    rolestringrequired

    Author role (WRITER, PENCILLER, INKER, COLORIST, LETTERER, COVER, EDITOR)

  • ]
  • createdstringrequired

    Created timestamp (ISO 8601)

    lastModifiedstringrequired

    Last modified timestamp (ISO 8601)

    releaseDatestring | nullnullable

    Release date range (earliest)

    summarystring

    Summary (from first book or series)

    summaryNumberstring

    Summary number (if multiple summaries)

    tagsstring[]

    Tags from all books

    booksReadCountinteger<int32>required

    Read books count

    booksUnreadCountinteger<int32>required

    Unread books count

    createdstringrequired

    Created timestamp (ISO 8601)

    deletedboolean

    Whether series is deleted (soft delete)

    fileLastModifiedstringrequired

    File last modified timestamp (ISO 8601)

    idstringrequired

    Series unique identifier (UUID as string)

    lastModifiedstringrequired

    Last modified timestamp (ISO 8601)

    libraryIdstringrequired

    Library ID

    metadata objectrequired

    Series metadata

    ageRatinginteger,null<int32>nullable

    Age rating

    ageRatingLockboolean

    Whether age_rating is locked

    alternateTitles object[]

    Alternate titles

  • Array [
  • labelstringrequired

    Title label (e.g., "Japanese", "Romaji")

    titlestringrequired

    The alternate title text

  • ]
  • alternateTitlesLockboolean

    Whether alternate_titles are locked

    createdstringrequired

    Metadata created timestamp (ISO 8601)

    genresstring[]

    Genres list

    genresLockboolean

    Whether genres are locked

    languagestring

    Language code

    languageLockboolean

    Whether language is locked

    lastModifiedstringrequired

    Metadata last modified timestamp (ISO 8601)

    links object[]

    External links

  • Array [
  • labelstringrequired

    Link label

    urlstringrequired

    Link URL

  • ]
  • linksLockboolean

    Whether links are locked

    publisherstring

    Publisher name

    publisherLockboolean

    Whether publisher is locked

    readingDirectionstring | nullnullable

    Reading direction (LEFT_TO_RIGHT, RIGHT_TO_LEFT, VERTICAL, WEBTOON)

    readingDirectionLockboolean

    Whether reading_direction is locked

    sharingLabelsstring[]

    Sharing labels

    sharingLabelsLockboolean

    Whether sharing_labels are locked

    statusstringrequired

    Series status (ENDED, ONGOING, ABANDONED, HIATUS)

    statusLockboolean

    Whether status is locked

    summarystring

    Series summary/description

    summaryLockboolean

    Whether summary is locked

    tagsstring[]

    Tags list

    tagsLockboolean

    Whether tags are locked

    titlestringrequired

    Series title

    titleLockboolean

    Whether title is locked

    titleSortstringrequired

    Sort title

    titleSortLockboolean

    Whether title_sort is locked

    totalBookCountinteger,null<int32>nullable

    Total book count (expected)

    totalBookCountLockboolean

    Whether total_book_count is locked

    namestringrequired

    Series name

    oneshotboolean

    Whether this is a oneshot (single book)

    urlstringrequired

    File URL/path

  • ]
  • emptybooleanrequired

    Whether the page is empty

    firstbooleanrequired

    Whether this is the first page

    lastbooleanrequired

    Whether this is the last page

    numberinteger<int32>required

    Current page number (0-indexed)

    numberOfElementsinteger<int32>required

    Number of elements on this page

    pageable objectrequired

    Pageable information

    offsetinteger<int64>required

    Offset from start (page_number * page_size)

    pageNumberinteger<int32>required

    Current page number (0-indexed)

    pageSizeinteger<int32>required

    Page size (number of items per page)

    pagedbooleanrequired

    Whether the pageable is paged (always true for paginated results)

    sort objectrequired

    Sort information

    emptybooleanrequired

    Whether the sort is empty

    sortedbooleanrequired

    Whether the results are sorted in ascending or descending order

    unsortedbooleanrequired

    Whether the results are unsorted

    unpagedbooleanrequired

    Whether the pageable is unpaged (always false for paginated results)

    sizeinteger<int32>required

    Page size

    sort objectrequired

    Sort information

    emptybooleanrequired

    Whether the sort is empty

    sortedbooleanrequired

    Whether the results are sorted in ascending or descending order

    unsortedbooleanrequired

    Whether the results are unsorted

    totalElementsinteger<int64>required

    Total number of elements across all pages

    totalPagesinteger<int32>required

    Total number of pages

    KomgaPage_KomgaSeriesDto
    {
    "content": [
    {
    "booksCount": 0,
    "booksInProgressCount": 0,
    "booksMetadata": {
    "authors": [
    {
    "name": "string",
    "role": "string"
    }
    ],
    "created": "string",
    "lastModified": "string",
    "releaseDate": "string",
    "summary": "string",
    "summaryNumber": "string",
    "tags": [
    "string"
    ]
    },
    "booksReadCount": 0,
    "booksUnreadCount": 0,
    "created": "string",
    "deleted": true,
    "fileLastModified": "string",
    "id": "string",
    "lastModified": "string",
    "libraryId": "string",
    "metadata": {
    "ageRating": 0,
    "ageRatingLock": true,
    "alternateTitles": [
    {
    "label": "string",
    "title": "string"
    }
    ],
    "alternateTitlesLock": true,
    "created": "string",
    "genres": [
    "string"
    ],
    "genresLock": true,
    "language": "string",
    "languageLock": true,
    "lastModified": "string",
    "links": [
    {
    "label": "string",
    "url": "string"
    }
    ],
    "linksLock": true,
    "publisher": "string",
    "publisherLock": true,
    "readingDirection": "string",
    "readingDirectionLock": true,
    "sharingLabels": [
    "string"
    ],
    "sharingLabelsLock": true,
    "status": "string",
    "statusLock": true,
    "summary": "string",
    "summaryLock": true,
    "tags": [
    "string"
    ],
    "tagsLock": true,
    "title": "string",
    "titleLock": true,
    "titleSort": "string",
    "titleSortLock": true,
    "totalBookCount": 0,
    "totalBookCountLock": true
    },
    "name": "string",
    "oneshot": true,
    "url": "string"
    }
    ],
    "empty": true,
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
    },
    "unpaged": true
    },
    "size": 0,
    "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
    },
    "totalElements": 0,
    "totalPages": 0
    }