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

slugstring required

Slug of the document to retrieve. A document's alternate slug (kept after a slug correction) also resolves.

Response

Document found

idstring uuid required
titlestring nullable required
slugstring nullable required
excerptstring nullable required
meta_titlestring nullable required
meta_descriptionstring nullable required
published_atstring date-time nullable required
social_imagestring nullable required
statusstring nullable required
card_image_urlstring nullable required
header_image_urlstring nullable required
social_image_urlstring nullable required
content_htmlstring nullable required
content_plain_textstring nullable required
no_indexboolean required
citations_htmlstring nullable required

Example response

{
  "author": {
    "id": "def0a21f-b81a-4f28-a3be-2c55ddfed52a",
    "name": "Example User",
    "avatar_url": "https://example.com/uploaded_thumbnail.jpg",
    "biography": "A short paragraph of biographical information.",
    "byline": "Nutrition Expert, Personal Trainer",
    "slug": "expert-user",
    "active_stack_freshness_id": "224657ee155701f107bac02022e930ed11aaaf682dabd830597a67b879236a67"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.