KomgaSeriesDto

Komga series DTO

Based on actual Komic traffic analysis.

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

KomgaSeriesDto

{
  "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"
}