Skip to content

Getting started

Your own state of a workspace's Getting started, the setup guide that opens on its Home for its owners: dismissed_at (when you dismissed it, so it no longer opens by itself; null while it does), skipped (the steps you chose to skip, in the guide's order: ai, ask, code, harness, people, runner) and updated_at (null when you never changed it).

GET/workspaces/{workspace}/onboarding

Whether a step is done is not here: it is the workspace’s own state, such as its AI providers, repositories, members and runners. Members only, as people; each person’s own.

Your own: each person has their own Getting started in each workspace they belong to. A person who never dismissed it gets dismissed_at null, and the guide opens by itself on the workspace’s Home while they own it and steps are left. Whether a step is done is not kept here but read from the workspace: its AI providers (GET /workspaces/{workspace}/ai/providers), repositories, members and runners. 404 for anyone who is not a member. See Getting started.

  • 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”.
curl https://api.g1t.sh/workspaces/flagon-io/onboarding \
-H "Authorization: Bearer $G1T_TOKEN"

A successful request answers 200 with:

{
"dismissed_at": null,
"skipped": [],
"updated_at": null
}

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.
422 invalid The input is not valid. message says which field and why.