---
title: "Readinglist"
method: GET
path: "/api/readinglist"
tags: ["readinglist"]
---

# Readinglist

`GET /api/readinglist`

This endpoint allows the client to retrieve a list of articles that were saved to a Users readinglist.
        It supports pagination, each page will contain `30` articles by default

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

A list of articles in the users readinglist

- ArticleIndex[]
  - `type_of` string, required
  - `id` integer, required
  - `title` string, required
  - `description` string, required
  - `cover_image` string, url, nullable, required
  - `readable_publish_date` string, required
  - `social_image` string, url, required
  - `tag_list` string[], required
  - `tags` string, required
  - `slug` string, required
  - `path` string, path, required
  - `url` string, url, required
  - `canonical_url` string, url, required
  - `positive_reactions_count` integer, required
  - `public_reactions_count` integer, required
  - `created_at` string, date-time, required
  - `edited_at` string, date-time, nullable, required
  - `crossposted_at` string, date-time, nullable, required
  - `published_at` string, date-time, required
  - `last_comment_at` string, date-time, required
  - `published_timestamp` string, date-time, required — Crossposting or published date time
  - `reading_time_minutes` integer, required — Reading time, in minutes
  - `user` SharedUser, required — The resource creator
    - `name` string
    - `username` string
    - `twitter_username` string, nullable
    - `github_username` string, nullable
    - `website_url` string, url, nullable
    - `profile_image` string — Profile image (640x640)
    - `profile_image_90` string — Profile image (90x90)
  - `flare_tag` ArticleFlareTag — Flare tag of the article
    - `name` string
    - `bg_color_hex` string — Background color (hexadecimal)
    - `text_color_hex` string — Text color (hexadecimal)
  - `organization` SharedOrganization — The organization the resource belongs to
    - `name` string
    - `username` string
    - `slug` string
    - `profile_image` string, url — Profile image (640x640)
    - `profile_image_90` string, url — Profile image (90x90)

## Other responses

- `401` — Unauthorized

## Changes

- **2023-01-10** (v1) `754f8b25f815` — 1 info
  - added the media type `application/json` for the response with the status `401`

[Change history](https://skmtc.dev/forem/apis/forem-api-v1/changes/api/readinglist/get.md)

---

[API](https://skmtc.dev/forem/apis/forem-api-v1.md) · [All operations](https://skmtc.dev/forem/apis/forem-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/forem/forem-api-v1/revisions/754f8b25f815/schema)
