List series

GET 
https://demo.komga.org/api/v1/series

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Use POST /api/v1/series/list instead. Deprecated since 1.19.0.

Request

Query Parameters

search string
library_id string[]
collection_id string[]
status string[]

Possible values: [ENDED, ONGOING, ABANDONED, HIATUS]

read_status string[]

Possible values: [UNREAD, READ, IN_PROGRESS]

publisher string[]
language string[]
genre string[]
tag string[]
age_rating string[]
release_year string[]
sharing_label string[]
deleted boolean
complete boolean
oneshot boolean
unpaged boolean
search_regex string

Search by regex criteria, in the form: regex,field. Supported fields are TITLE and TITLE_SORT.

page integer

Zero-based page index (0..N)

size integer

The size of the page to be returned

sort string[]

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

author string[]

Author criteria in the format: name,role. Multiple author criteria are supported.

Responses

200

OK

application/json

Schema

Schema

content object[]
Array [
booksCountint32required
booksInProgressCountint32required
booksMetadata objectrequired
authors object[]required
Array [
namestringrequired
rolestringrequired
]
createddate-timerequired
lastModifieddate-timerequired
releaseDatedate
summarystringrequired
summaryNumberstringrequired
tagsstring[]required
booksReadCountint32required
booksUnreadCountint32required
createddate-timerequired
deletedbooleanrequired
fileLastModifieddate-timerequired
idstringrequired
lastModifieddate-timerequired
libraryIdstringrequired
metadata objectrequired
ageRatingint32
ageRatingLockbooleanrequired
alternateTitles object[]required
Array [
labelstringrequired
titlestringrequired
]
alternateTitlesLockbooleanrequired
createddate-timerequired
genresstring[]required
genresLockbooleanrequired
languagestringrequired
languageLockbooleanrequired
lastModifieddate-timerequired
links object[]required
Array [
labelstringrequired
urlstringrequired
]
linksLockbooleanrequired
publisherstringrequired
publisherLockbooleanrequired
readingDirectionstringrequired
readingDirectionLockbooleanrequired
sharingLabelsstring[]required
sharingLabelsLockbooleanrequired
statusstringrequired
statusLockbooleanrequired
summarystringrequired
summaryLockbooleanrequired
tagsstring[]required
tagsLockbooleanrequired
titlestringrequired
titleLockbooleanrequired
titleSortstringrequired
titleSortLockbooleanrequired
totalBookCountint32
totalBookCountLockbooleanrequired
namestringrequired
oneshotbooleanrequired
urlstringrequired
]
emptyboolean
firstboolean
lastboolean
numberint32
numberOfElementsint32
pageable object
offsetint64
pageNumberint32
pageSizeint32
pagedboolean
sort object
emptyboolean
sortedboolean
unsortedboolean
unpagedboolean
sizeint32
sort object
emptyboolean
sortedboolean
unsortedboolean
totalElementsint64
totalPagesint32

Example (auto)

{
  "content": [
    {
      "booksCount": 0,
      "booksInProgressCount": 0,
      "booksMetadata": {
        "authors": [
          {
            "name": "string",
            "role": "string"
          }
        ],
        "created": "2024-07-29T15:51:28.071Z",
        "lastModified": "2024-07-29T15:51:28.071Z",
        "releaseDate": "2024-07-29",
        "summary": "string",
        "summaryNumber": "string",
        "tags": [
          "string"
        ]
      },
      "booksReadCount": 0,
      "booksUnreadCount": 0,
      "created": "2024-07-29T15:51:28.071Z",
      "deleted": true,
      "fileLastModified": "2024-07-29T15:51:28.071Z",
      "id": "string",
      "lastModified": "2024-07-29T15:51:28.071Z",
      "libraryId": "string",
      "metadata": {
        "ageRating": 0,
        "ageRatingLock": true,
        "alternateTitles": [
          {
            "label": "string",
            "title": "string"
          }
        ],
        "alternateTitlesLock": true,
        "created": "2024-07-29T15:51:28.071Z",
        "genres": [
          "string"
        ],
        "genresLock": true,
        "language": "string",
        "languageLock": true,
        "lastModified": "2024-07-29T15:51:28.071Z",
        "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
}

400

Bad Request

*/*

Schema

Schema

violations object[]required
Array [
fieldNamestring
messagestring
]

Example (auto)

{
  "violations": [
    {
      "fieldName": "string",
      "message": "string"
    }
  ]
}

Authorization: http

name: basicAuthtype: httpscheme: basic

• curl
• python
• nodejs
• java
• kotlin
• powershell
• swift
• rust

• CURL

curl -L 'https://demo.komga.org/api/v1/series' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Request Collapse all

Base URL

https://demo.komga.org

Auth

Security Scheme

basicAuthapiKey

Username

Password

Parameters

search — query

library_id — query

collection_id — query

status — query

ENDEDONGOINGABANDONEDHIATUS

read_status — query

UNREADREADIN_PROGRESS

publisher — query

language — query

genre — query

tag — query

age_rating — query

release_year — query

sharing_label — query

deleted — query

---truefalse

complete — query

---truefalse

oneshot — query

---truefalse

unpaged — query

---truefalse

search_regex — query

page — query

size — query

sort — query

author — query

ResponseClear

Click the Send API Request button above and see the response here!