Skip to content

Get onboarding conversation state

GET
/api/v1/enterprise/onboarding

Returns the current enterprise onboarding progress for the authenticated tenant, including which steps are completed, the current step, and results for completed steps.

Authorizations

Responses

200

Successful Response

Response for GET /api/v1/enterprise/onboarding.

Attributes: tenant_id: The tenant identifier. current_step: The next step to complete (1-6, or 7 if all done). total_steps: Total number of onboarding steps (always 6). completed_steps: List of completed step numbers. steps: Full state for all 6 steps. is_complete: Whether all steps have been completed.

object
completed_steps
required
Array<integer>
current_step
required
integer
is_complete
required
boolean
steps
required
Array<object>

State for a single onboarding step.

Attributes: step_number: The step number (1-6). name: Step name (e.g. ‘map_organization’). status: ‘pending’, ‘completed’, or ‘skipped’. result: Step result if completed, None otherwise.

object
name
required
string
result
Any of:
status
required
string
step_number
required
integer
tenant_id
required
string
total_steps
integer
default: 6