---
title: "Read the canonical setup (connect, brand, domain) without creating resources or sending email."
method: GET
path: "/v1/workspaces/{workspaceId}/onboarding/guided"
---

# Read the canonical setup (connect, brand, domain) without creating resources or sending email.

`GET /v1/workspaces/{workspaceId}/onboarding/guided`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/onboarding/guided`
- Auth: HTTP bearer

## Query parameters

- `details` 1

## Response `200`

Persisted progress and independently verified capabilities.

- object
  - `data` GuidedOnboardingState, required
    - `product_id` string, uuid, required
    - `lesson` OnboardingLesson
      - `step` string, required
      - `purpose` string, required
      - `setup` string, required
      - `boundary` string, required
      - `example_request` string, required
      - `result` string, required
      - `choice` string, required
      - `skip` string, nullable, required
    - `guidance` string
    - `current_step` 'connect' | 'business' | 'identity' | 'sending', required
    - `completed_count` integer, required
    - `total_steps` 4, required
    - `setup` object: The web setup gate and finish-setup banner. Each part is complete, verifying (domain records added, DNS still checking), skipped or missing.
      - `connect` 'complete' | 'skipped' | 'missing', required
      - `brand` 'complete' | 'skipped' | 'missing', required
      - `domain` 'complete' | 'verifying' | 'skipped' | 'missing', required
      - `gate_open` boolean, required: True while brand or domain was neither done nor skipped.
      - `missing` string[], required: Parts skipped or never done
    - `unlock_video_due` boolean: True once a domain is verified until the workspace has seen the "what you can do now" video.
    - `agent_client_name` string, nullable: The connected AI app
    - `complete` boolean, required
    - `shared_education_complete` boolean
    - `outcome` 'in_progress' | 'production_deferred' | 'production_ready', required
    - `recommended_action` string, required
    - `readiness` object, required
    - `progress` object, required
    - `steps` object[], required
      - `id` string, required
      - `title` string, required
      - `explanation` string
      - `status` 'not_started' | 'in_progress' | 'waiting' | 'needs_attention' | 'complete' | 'skipped', required
      - `blocking_dependency` string, nullable
      - `recommended_action` string
      - `actions` string[], required
      - `resource_ids` string[], required
      - `evidence` object, required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)