Get a guide

Returns a single guide by ID. Optional include values can add tags, skills, and the places where the guide appears.

Think of this as the API equivalent of viewing a guide from the admin overview and edit page. It returns high-level properties of a single guide — title, description, published state, estimated duration, task count, author, tags and skills, badge and certification info, repeat-assignment settings, and sharing settings — rather than its contents or anyone's progress through it. Use it when you already know which guide you want and need its properties.

Example: an internal portal that shows a formatted "course info" page for a single guide, pulling the title, description and estimated time from Learn:Up.
If you're looking for guide-related data and don't see it here, check the other guide endpoints — List Guide Steps for what's inside the guide, and List Guide Assignments for who has it and how far along they are.

Path Params
string
required

Guide ID.

Query Params
includes
array of strings
Defaults to []

Comma-separated related data to include in the response. tags, skills, and appears_in add the tags, skills, and appearsIn fields respectively.

includes
Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json