Deskhero Developer Hub
Back to deskhero.com
Dashboard

Wizard light

Returns the getting started checklist for the workspace, the steps of the setup, knowledge and AI answers sections each with its completed state, the same items the dashboard embeds when include_wizard is set.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/dashboard/wizard_light
Authorisation
Minimum role: USER

Request arguments

Name Type Source
Request body example
No input arguments

Response

Status
200 (OK)
Type
DTO_wizard_light_item[]
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_wizard_light_item
NameTypeReadOnlyDescription
titleStringTitle
descriptionStringDescription
description_longStringDescription long
button_textStringButton text
urlStringUrl
tooltipStringTooltip
categoryStringCategory
completedBooleanCompleted
section_keyStringStable grouping key for the frontend ("setup" | "knowledge" | "ai")
section_titleStringLocalized section heading, identical for all items sharing a section_key
lockedBooleanThe step depends on another step that is not far enough along yet (e.g. AI features waiting for the approved-FAQ minimum)
locked_textStringLocalized chip text explaining what unlocks the step; only set when locked
ready_textStringLocalized chip text shown when a previously gated step is unlocked but not yet completed
progress_currentInt32 (nullable)Progress meter numerator (e.g. approved FAQ count); null when the step has no meter
progress_targetInt32 (nullable)Progress meter denominator (e.g. the approved-FAQ minimum for AI features)
progress_textStringLocalized label for the progress meter, e.g. "46 of 100 approved Q&As"

Generated Aug 4, 2026 18:37