onboarding
onboarding

Get Onboarding Status

Get current onboarding state for the user.

Returns status, current product, step, and any saved data. Used by frontend to determine where to resume.

get/api/onboarding/status

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/onboarding/status
  • Auth: none declared

Response

Successful Response

status'pending' | 'in_progress' | 'skipped' | 'completed' required
product'livechat' | 'social-boost' | 'ai-communication' nullable
stepinteger
goal'get_leads' | 'respond_faster' | 'automate' | 'boost_engagement' | 'manage_inbox' | 'reach_people' | 'capture_leads' | 'nurture' nullable
dataobject
completed_atstring nullable
can_skipboolean
resume_messagestring nullable
show_superagent_welcomeboolean
superagent_welcome_completedboolean

Changes

No recorded changes to this operation across all 5 revisions of this API.