---
title: "Get a document by slug"
method: GET
path: "/api/documents/{slug}"
tags: ["documents"]
---

# Get a document by slug

`GET /api/documents/{slug}`

## Request

- Base URL: `https://api.supp.co`
- URL: `https://api.supp.co/api/documents/{slug}`
- Auth: none required

## Path parameters

- `slug` string, required

## Response `200`

Document found

- Document
  - `id` string, uuid, required
  - `title` string, nullable, required
  - `slug` string, nullable, required
  - `excerpt` string, nullable, required
  - `meta_title` string, nullable, required
  - `meta_description` string, nullable, required
  - `published_at` string, date-time, nullable, required
  - `author` LimitedPublicUser, required: LimitedPublicUserSerializer payload: a User without a Stack. Used for most_saved, document authors, and (as UserPostAuthor) post authors and expert lists. The same attributes are repeated under `user`.
    - `id` string, uuid, required
    - `name` string, nullable, required
    - `avatar_url` string, nullable, required
    - `biography` string, nullable, required
    - `byline` string, nullable, required
    - `expertise` string, nullable, required
    - `credentials` string, nullable, required
    - `is_expert` boolean, nullable, required
    - `slug` string, nullable, required: A friendly URL id for the user. Only set for Editor/Expert users.
    - `active_stack_freshness_id` string, required: SHA-256 cache-busting value for the active stack.
    - `is_verified` boolean, required
    - `user` UserPostAuthorAttributes, required: Keys emitted by LimitedPublicUserSerializer (also repeated under `user`).
      - `active_stack_freshness_id` string, required
      - `avatar_url` string, nullable, required
      - `biography` string, nullable, required
      - `byline` string, nullable, required
      - `credentials` string, nullable, required
      - `expertise` string, nullable, required
      - `id` string, uuid, required
      - `is_expert` boolean, nullable, required
      - `is_verified` boolean, required
      - `name` string, nullable, required
      - `slug` string, nullable, required
  - `social_image` string, nullable, required
  - `status` string, nullable, required
  - `card_image_url` string, nullable, required
  - `header_image_url` string, nullable, required
  - `social_image_url` string, nullable, required
  - `content_html` string, nullable, required
  - `content_plain_text` string, nullable, required
  - `no_index` boolean, required
  - `citations_html` string, nullable, required
  - `topic` object, nullable, required
    - `id` string, required
    - `comments_count` integer, required
    - `likes_count` integer, required
    - `featured` boolean, required

## Other responses

- `404`: The specified resource was not found
- `500`: An unexpected error occurred

---

[API](https://skmtc.dev/supp/apis/suppco-public-api.md) · [All operations](https://skmtc.dev/supp/apis/suppco-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/supp/apis/suppco-public-api/revisions/e088e6cdcb6b?raw)