---
title: "List readme links"
method: GET
path: "/links/readme"
tags: ["Links"]
---

# List readme links

`GET /links/readme`

Fetch readme URLs for projects. Optional `limit` query param limits results.

## Query parameters

- `limit` integer

## Response `200`

Readme links

- object
  - `readme_links` ReadmeLink[]
    - `id` integer
    - `title` string
    - `readme_url` string

## Other responses

- `401` — Missing or invalid API key

---

[API](https://skmtc.net/hackclub/apis/flavortown-api.md) · [All operations](https://skmtc.net/hackclub/apis/flavortown-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hackclub/flavortown-api/revisions/30b9ad477190/schema)