SeriesFullMetadata

Nested metadata object for FullSeriesResponse

ageRatinginteger,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

roleBookAuthorRole (string)required

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 lockable metadata fields

ageRatingbooleanrequired

Whether the age_rating field is 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

totalBookCountbooleanrequired

Whether the total_book_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

totalBookCountinteger,null<int32>nullable

Expected total book count (for ongoing series)

Example: 4

updatedAtstring<date-time>required

When the metadata was last updated

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

yearinteger,null<int32>nullable

Release year

Example: 1987

SeriesFullMetadata

{
  "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,
    "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,
    "totalBookCount": 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",
  "totalBookCount": 4,
  "updatedAt": "2024-01-15T10:30:00Z",
  "year": 1987
}