Skip to main content

SeriesMetadataResponse

Response containing series metadata

ageRatinginteger,null<int32>nullable

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

Example: 16
customMetadataobject | nullnullable

Custom JSON metadata for extensions

idstring<uuid>required

Series ID

Example: 550e8400-e29b-41d4-a716-446655440002
imprintstring | nullnullable

Imprint (sub-publisher)

Example: Vertigo
languagestring | nullnullable

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

Example: en
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/name

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

Last update timestamp

Example: 2024-01-15T10:30:00Z
yearinteger,null<int32>nullable

Release year

Example: 1987
SeriesMetadataResponse
{
"ageRating": 16,
"customMetadata": "Unknown Type: object,null",
"id": "550e8400-e29b-41d4-a716-446655440002",
"imprint": "Vertigo",
"language": "en",
"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
}