ReadingList

Fetches all reading list items for a given list including rich metadata around series, volume, chapters, and progress

Changed on

This call is expensive

get/api/ReadingList/items

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/ReadingList/items
  • Auth
    API key in header x-api-key

Query parameters

readingListIdinteger

Response

OK

idinteger
orderinteger
chapterIdinteger
seriesIdinteger
seriesNamestring nullable
seriesSortNamestring nullable
seriesFormat0 | 1 | 2 | 3 | 4

Members:

  • 0 — Image
  • 1 — Archive
  • 2 — Unknown
  • 3 — EPUB (Epub)
  • 4 — PDF (Pdf)
pagesReadinteger
pagesTotalinteger
chapterNumberstring nullable
volumeNumberstring nullable
chapterTitleNamestring nullable
volumeIdinteger
libraryIdinteger
titlestring nullable
libraryType0 | 1 | 2 | 3 | 4 | 5

Members:

  • 0 — Manga
  • 1 — Comic (Flexible) (Comic)
  • 2 — Book
  • 3 — Image
  • 4 — Light Novel (LightNovel)
  • 5 — Comic (ComicVine)
libraryNamestring nullable
releaseDatestring date-time nullable
readingListIdinteger
lastReadingProgressUtcstring date-time nullable
fileSizeinteger
summarystring nullable
isSpecialboolean

Changes

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      response property items/chapterNumber deprecated (media type: text/plain)

    • info

      response property items/chapterNumber deprecated (media type: application/json)

    • info

      response property items/chapterNumber deprecated (media type: text/json)

    • info

      response property items/chapterTitleName deprecated (media type: text/plain)

    • info

      response property items/chapterTitleName deprecated (media type: application/json)

    • info

      response property items/chapterTitleName deprecated (media type: text/json)

    • info

      response property items/fileSize deprecated (media type: text/plain)

    • info

      response property items/fileSize deprecated (media type: application/json)

    • info

      response property items/fileSize deprecated (media type: text/json)

    • info

      response property items/isSpecial deprecated (media type: text/plain)

    • info

      response property items/isSpecial deprecated (media type: application/json)

    • info

      response property items/isSpecial deprecated (media type: text/json)

    • info

      response property items/pagesTotal deprecated (media type: text/plain)

    • info

      response property items/pagesTotal deprecated (media type: application/json)

    • info

      response property items/pagesTotal deprecated (media type: text/json)

    • info

      response property items/releaseDate deprecated (media type: text/plain)

    • info

      response property items/releaseDate deprecated (media type: application/json)

    • info

      response property items/releaseDate deprecated (media type: text/json)

    • info

      response property items/summary deprecated (media type: text/plain)

    • info

      response property items/summary deprecated (media type: application/json)

    • info

      response property items/summary deprecated (media type: text/json)

    • info

      response property items/volumeNumber deprecated (media type: text/plain)

    • info

      response property items/volumeNumber deprecated (media type: application/json)

    • info

      response property items/volumeNumber deprecated (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)