---
title: "Get a guide by id"
method: GET
path: "/v1/guides/{id}"
tags: ["guides"]
---

# Get a guide by id

`GET /v1/guides/{id}`

## Request

- Base URL: `https://partners-api.thriveglobal.com`
- URL: `https://partners-api.thriveglobal.com/v1/guides/{id}`
- Auth: HTTP bearer

Returns a single guide by its id, including a link to the PDF, its page count, a cover image, and tags. Returns `404` when no guide exists for the id and `422` when the id is not a UUID.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `locale` string

## Response `200`

The guide

- object
  - `data` GuideItem: A guide — a downloadable PDF resource, with a cover image to display alongside it.
    - `id` string, uuid, required
    - `type` 'guide', required
    - `name` string, required
    - `description` string, nullable, required
    - `createdAt` string, date-time, nullable, required
    - `updatedAt` string, date-time, nullable, required
    - `locale` string, nullable, required: Served locale, not request echo
    - `tags` TaxonomyTerm[], required
      - `id` string, nullable, required: Stable identifier for the term; null where none exists
      - `slug` string, required
      - `name` string, nullable, required
    - `conditions` TaxonomyTerm[], required: Always empty on guides today. The field is present for consistency with the other content resources.
      - `id` string, nullable, required: Stable identifier for the term; null where none exists
      - `slug` string, required
      - `name` string, nullable, required
    - `coreHealthBehaviors` TaxonomyTerm[], required: Always empty on guides today. The field is present for consistency with the other content resources.
      - `id` string, nullable, required: Stable identifier for the term; null where none exists
      - `slug` string, required
      - `name` string, nullable, required
    - `pageCount` integer, nullable, required: How many pages the PDF contains. **This is not a pagination field** — it tells you nothing about how many guides the endpoint returned or how many pages of results there are. Use `meta.pagination` and `links` for that.
    - `media` MediaEntry[], required: The downloadable file — a single `kind: "file"` entry holding the guide PDF. A guide with no PDF attached returns an empty array; there is never an entry with an empty `url`. `contentType` is `application/pdf` where it can be determined from the file, and `null` where it cannot — treat a null as a PDF.
      - `kind` 'file' | 'manifest' | 'embed', required
      - `orientation` 'landscape' | 'portrait', nullable, required
      - `contentType` string, nullable, required: MIME type where known
      - `url` string, uri, required
    - `assets` AssetEntry[], required: Supporting files — the cover image, as a `role: "image-featured"` entry with its alt text in `alt`. A guide with no cover image returns an empty array. `contentType` is `null` where the image format cannot be determined from the file.
      - `role` 'captions' | 'transcript' | 'image-landscape' | 'image-portrait' | 'thumbnail-landscape' | 'thumbnail-portrait' | 'image-featured', required
      - `contentType` string, nullable, required
      - `url` string, uri, required
      - `alt` string, nullable, required
      - `sizes` object: Explicit size-variant URLs where they exist. Never derive variants by transforming URLs.

## Other responses

- `401`: Unauthorized — missing, invalid, or expired token
- `404`: No guide exists for the id
- `422`: Invalid id (must be a UUID) or query parameters
- `502`: Service temporarily unavailable

## Changes

- **2026-09-25** `bb4f887e7e09`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/thriveglobal/apis/thrive-global-partner-api/changes/v1/guides/:id/get.md)

---

[API](https://skmtc.dev/thriveglobal/apis/thrive-global-partner-api.md) - [All operations](https://skmtc.dev/thriveglobal/apis/thrive-global-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thriveglobal/apis/thrive-global-partner-api/revisions/c18a31de927e?raw)
