guides

Get a guide by id

Changed on

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.

get/v1/guides/{id}

Request

  • Base URL
    https://partners-api.thriveglobal.com
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Guide id

Query parameters

localestring

Locale, forwarded as the thrive-locale header

Response

The guide

Example response

{
  "data": {
    "id": "244755bc-0a3b-44ca-a3d6-e09ff69eb53a",
    "name": "Living and Working with Arthritis",
    "description": "A practical guide to managing arthritis at work.",
    "locale": "en-US",
    "tags": [
      {
        "slug": "sleep",
        "name": "Sleep"
      }
    ],
    "conditions": [
      {
        "slug": "sleep",
        "name": "Sleep"
      }
    ],
    "coreHealthBehaviors": [
      {
        "slug": "sleep",
        "name": "Sleep"
      }
    ],
    "pageCount": 11,
    "media": [
      {
        "contentType": "audio/mpeg"
      }
    ],
    "assets": [
      {
        "contentType": "image/jpeg"
      }
    ]
  }
}

Changes