API ReferenceSpaces

Get a guidance

Retrieves a guidance by its id

Path parameters

spaceIdstringRequired
ID of the space
guidanceIdstringRequired
ID of the guidance

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Query parameters

includeGuidebooleanOptional
Include the guide with the guidance, default is false

Response

This endpoint returns an object.
idstring
Guidance ID
guideSlugstring
optionsobject
createdFromstring or null
The guidance id of the template that was used to create this guidance
lastPropagatedAtdatetime or null
The last time the guidance template configuration was propagated to this guidance

Errors