Skip to content
GitmoapAPIBeta
Schema

OnboardingStateView

The response for GET/PATCH /user/onboarding.

Shape

  • activationOnboardingActivation
    • The OnboardingActivation schema
    • has_access_tokenbooleanWhether the caller holds any personal access token (a connected git client).
    • clone_hintstring or nulloptionalA suggested git clone command for a new repo in the namespace.
    • personal_group_idGroupId (string · uuid) or nulloptionalThe personal namespace group id — lets the frontend PUT /groups/{id} and target repo creation without a path→id lookup that a mid-Welcome namespace rename would desync.
    • personal_namespace_pathstring or nulloptionalThe personal namespace's current path to clone into.
  • dismissedboolean
  • intentOnboardingIntentsoloteamunknownThe person's stated goal, captured by the first-run Welcome. Unknown is the canonical "the Welcome has not been completed" signal — a fresh record starts here, and the first PATCH to Solo/Team retires the Welcome. There is deliberately no separate "onboarded" flag.
  • required_stepsarray of string
  • stepsOnboardingSteps
    • The OnboardingSteps schema
    • connected_git_clientstring or nulloptional
    • created_first_repostring or nulloptional
    • created_namespacestring or nulloptional
    • email_verifiedstring or nulloptional
    • pushed_first_commitstring or nulloptional
  • completed_atstring or nulloptional
  • next_stepstring or nulloptional

Example

Synthesized example
{
"activation": {
"has_access_token": false,
"clone_hint": "clone-hint-b6fe",
"personal_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"personal_namespace_path": "personal-namespace-path-2b52"
},
"dismissed": false,
"intent": "solo",
"required_steps": [
"required-steps-0294"
],
"steps": {
"connected_git_client": "connected-git-client-3c1f",
"created_first_repo": "created-first-repo-20d6",
"created_namespace": "created-namespace-1dfc",
"email_verified": "mara@acme.example",
"pushed_first_commit": "pushed-first-commit-b481"
},
"completed_at": "2026-10-09T14:21:17Z",
"next_step": "next-step-3dcc"
}

Graph

Used inside

No schema contains this one.

Used by