KAkareadita
ReadingList

Returns reading lists (paginated) for a given user.

Changed on
post/api/ReadingList/lists

Request

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

Query parameters

PageNumberinteger
PageSizeinteger
includePromotedboolean

Include Promoted Reading Lists along with user's Reading Lists. Defaults to true

sortByLastModifiedboolean

Sort by last modified (most recent first) or by title (alphabetical)

Response

OK

idinteger
titlestring nullable
summarystring nullable
promotedboolean
coverImageLockedboolean
coverImagestring nullable
primaryColorstring nullable
secondaryColorstring nullable
itemCountinteger
startingYearinteger
startingMonthinteger
endingYearinteger
endingMonthinteger
ageRating0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1 required

Members:

  • 0 — Unknown
  • 1 — Rating Pending (RatingPending)
  • 2 — Early Childhood (EarlyChildhood)
  • 3 — Everyone
  • 4 — G
  • 5 — Everyone 10+ (Everyone10Plus)
  • 6 — PG
  • 7 — Kids to Adults (KidsToAdults)
  • 8 — Teen
  • 9 — MA15+ (Mature15Plus)
  • 10 — Mature 17+ (Mature17Plus)
  • 11 — M (Mature)
  • 12 — R18+ (R18Plus)
  • 13 — Adults Only 18+ (AdultsOnly)
  • 14 — X18+ (X18Plus)
  • -1 — Not Applicable (NotApplicable)
ownerUserNamestring nullable
sourcePathstring nullable
downloadUrlstring nullable
shaHashstring nullable
provider0 | 1 | 2

Members:

  • 0 — File (None)
  • 1 — File
  • 2 — Url
lastSyncCheckUtcstring date-time nullable
lastSyncedUtcstring date-time nullable
totalItemsAtImportinteger
canSyncboolean

Changes

  • ad5fe542f4b8Revision 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

      the response optional property / became not read-only for the status (media type: text/plain)

    • info

      the response optional property / became not read-only for the status (media type: application/json)

    • info

      the response optional property / became not read-only for the status (media type: text/json)

  • 777fe1636b50Revision 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

      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

      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

      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)