List guides

Returns a paginated list of guides for the authenticated user's enterprise. Optional include values can add tags, skills, and the places where each guide appears.

Returns every guide in your account, page by page, with the same properties as Get Guide for each one. This is the endpoint for building an inventory of what exists, rather than for digging into any single guide. If a guide hasn't been published yet, publishedAt will be null.

Example: syncing your full guide catalogue into a data warehouse, or into an intranet search index so employees can find learning content without logging into Learn:Up.

Use Get Guide instead when you already know the guide you want. If you need what's inside each guide, or who it's assigned to, pair this with List Guide Steps and List Guide Assignments — a common pattern is to list guides once to get their IDs, then call the other endpoints per guide.

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:
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