KAkareadita
WantToRead

Return all Series that are in the current logged in user's Want to Read list, filtered

Changed on
post/api/want-to-read/v2

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/want-to-read/v2
  • Auth
    API key in header x-api-key

Query parameters

PageNumberinteger
PageSizeinteger
userIdinteger

Optional user id to request the OnDeck for someone else. They must have profile sharing enabled when doing so

Request body

idinteger
namestring nullable
combination0 | 1

Members:

  • 0 — Or
  • 1 — And
entityType0 | 1 | 2 | 3

Members:

  • 0 — Series
  • 1 — Reading List (ReadingList)
  • 2 — Person
  • 3 — Annotation
limitTointeger

Response

OK

idinteger
namestring nullable
originalNamestring nullable
localizedNamestring nullable
sortNamestring nullable
pagesinteger
coverImageLockedboolean
lastChapterAddedstring date-time
lastChapterAddedUtcstring date-time
userRatingnumber float
hasUserRatedboolean
totalReadsinteger
pagesReadinteger
latestReadDatestring date-time
format0 | 1 | 2 | 3 | 4

Members:

  • 0 — Image
  • 1 — Archive
  • 2 — Unknown
  • 3 — EPUB (Epub)
  • 4 — PDF (Pdf)
createdstring date-time
sortNameLockedboolean
localizedNameLockedboolean
nameLockedboolean
wordCountinteger
libraryIdinteger
libraryNamestring nullable
minHoursToReadinteger
maxHoursToReadinteger
avgHoursToReadnumber float
folderPathstring nullable
lowestFolderPathstring nullable
lastFolderScannedstring date-time
dontMatchboolean
isBlacklistedboolean
isStandAloneboolean
metadataProviderOverride2 | 3 | 4

Members:

  • 2 — Hardcover
  • 3 — Mangabaka
  • 4 — ComicBookRoundup
coverImagestring nullable
primaryColorstring nullable
secondaryColorstring nullable
aniListIdinteger
malIdinteger
hardcoverIdinteger
metronIdinteger
comicVineIdstring nullable
mangaBakaIdinteger
mangaBakaEditionIdstring nullable
cbrIdinteger

Changes

  • 8f6bc4f38f06Revision 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)

  • cc7f90a35897Revision changes
    • info

      added the new 34.00 enum value to the request property // (media type: application/json)

    • info

      added the new 34.00 enum value to the request property // (media type: text/json)

    • info

      added the new 34.00 enum value to the request property // (media type: application/*+json)