List guide steps

Returns a paginated list of published steps for a guide.

Think of this as the API equivalent of a guide's step list in admin. It returns every step in a guide, in order, with the section and task each one sits under — and for each step, the options and configuration you'd see if you opened it.

Properties shared by all steps (name, type, position) sit at the top level. Anything that only applies to certain step types lives in the content property. Not every step type has content support yet — see the list below for which are covered today. More will be added over time.

Example: a report showing exactly what's inside a guide — "this onboarding guide has 3 videos, 2 documents and a 5-question quiz" — without anyone opening it and clicking through.
This endpoint describes the guide as authored, not what any learner did with it. For a learner's results step by step, use List Guide Assignment Steps. To fetch the actual file behind a file-type step, use Download Guide Step File.

Path Params
string
required

Guide ID.

Query Params
integer
required
1 to 200

Maximum number of records to return. Must be between 1 and 200.

string
enum
required

Pagination type.

Allowed:
integer
0 to 10000

Zero-based offset for offset pagination. Must be between 0 and 10000. Do not provide with cursor pagination.

string

Cursor for cursor pagination. Do not provide with offset pagination.

Response

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