guides

Returns a paginated list of guides — downloadable PDF resources, such as condition explainers and practical workbooks, that can be read offline, printed, or shared. Each guide includes a link to the PDF, its page count, a cover image, and tags.

Note that pageCount counts the pages inside the PDF. It is not a pagination field — meta.pagination and links are what describe the page of results.

get/v1/guides

Request

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

Query parameters

offsetinteger

Zero-based item offset

limitinteger

Page size. Values above 100 are clamped to 100, not rejected; meta.pagination reports the applied value.

localestring

Locale, forwarded as the thrive-locale header

Response

A page of guides

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"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "limit": 10
    }
  },
  "links": {
    "self": "/v1/soundscapes?offset=0&limit=10",
    "next": "/v1/soundscapes?offset=10&limit=10"
  }
}

Changes