Skip to content

Getting started

Change your own Getting started in a workspace; fields left out stay as they are. dismissed true dismisses it, so it no longer opens by itself on the workspace's Home (dismissing it again keeps the first time); false makes it open by itself again. skipped replaces the steps you skipped: any of ai, ask, code, harness, people and runner.

PATCH/workspaces/{workspace}/onboarding

Opening the guide from Settings or the AI page changes nothing here. Members only, as people; each person’s own.

Dismissing it again keeps the first dismissed_at; "dismissed": false makes it open by itself again. A step that is not one of ai, ask, code, harness, people and runner is refused with 422. Opening the guide again from the workspace’s settings or its AI page changes nothing here.

  • Authentication: Required. Send an access token as Authorization: Bearer.
  • MCP tool: None. Signing in is on the REST API only.
Name Type Required Description
workspace string Yes The workspace’s name, e.g. “acme”.

Send a JSON object. Names are snake_case, as in responses; the camelCase spelling is accepted too.

Name Type Required Description
dismissed boolean No True dismisses it, so it no longer opens by itself; false makes it open by itself again.
skipped array of strings No The steps you skip, replacing those you skipped before. An empty list skips none. One of ai, ask, code, harness, people, runner.
curl -X PATCH https://api.g1t.sh/workspaces/flagon-io/onboarding \
-H "Authorization: Bearer $G1T_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"dismissed": true,
"skipped": [
"people",
"runner"
]
}'

A successful request answers 200 with:

{
"dismissed_at": "2026-10-14T21:05:00.000Z",
"skipped": [
"people",
"runner"
],
"updated_at": "2026-10-14T21:05:00.000Z"
}

A failed request answers with one of these statuses and a body like {"error": {"code": "not_found", "message": "Repository not found."}}. See errors.

Status Code When
401 unauthenticated A token is required, or the one sent is not valid.
403 forbidden The token is valid but not allowed to do this, such as a member-only change, or a token without the scope it needs.
404 not_found It does not exist, or you cannot see it.
409 conflict The request conflicts with the current state.
422 invalid The input is not valid. message says which field and why.