Skip to content
GitmoapAPIBeta
Identity & platformonboarding
GET/user/onboarding

Read the caller's personal onboarding state (the getting-started checklist)

get_user_onboarding

Each step — email verified, personal namespace created, first repository created, first commit pushed, a git client connected with an access token — is checked against what you have actually done whenever you read it, alongside the next step to take, your stated intent, whether you dismissed the checklist and a suggested clone command for your namespace. It never answers not found: a first read returns a fresh checklist, with intent unknown until you set one.

Responses

200Onboarding stateapplication/json
  • 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
200 exampleSynthesized example
{
"activation": {
"has_access_token": false,
"clone_hint": "clone-hint-a8a0",
"personal_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"personal_namespace_path": "personal-namespace-path-ad65"
},
"dismissed": false,
"intent": "solo",
"required_steps": [
"required-steps-e9ee"
],
"steps": {
"connected_git_client": "connected-git-client-3198",
"created_first_repo": "created-first-repo-f7d6",
"created_namespace": "created-namespace-4f8a",
"email_verified": "tomas@acme.example",
"pushed_first_commit": "pushed-first-commit-519f"
},
"completed_at": "2026-10-14T02:30:01Z",
"next_step": "next-step-7c78"
}
401Unauthorizedapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-8b25",
"message": "Inline scalar newtypes but keep their brand"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-5053",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap onboarding get-user-onboarding

Used in these guides