> ## Documentation Index
> Fetch the complete documentation index at: https://e328d4e-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://e328d4e-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://e328d4e-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://e328d4e-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Get onboarding state (/docs/api/account/onboarding-get-state)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 817 · updated: 2026-11-16 -->
Related: [Create a checkout link](/docs/api/account/billing-create-checkout-link.md), [Create workspace](/docs/api/account/companies-create.md), [Send feedback](/docs/api/account/feedback-send.md), [Get the Google connect link](/docs/api/account/google-get-connect-link.md), [Invite teammates](/docs/api/account/invitations-send.md), [Complete onboarding](/docs/api/account/onboarding-complete.md)

> Where the signed-in person is in Product Metrics onboarding: the current step, the steps already done, the account type and Google Ads connection mode, and demo status.

`GET https://prod-backend.productmetrics.io/api/public/v1/onboarding`

**Scope** `read` · **Access** Read only · **Operation id** `onboarding.get_state`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)).



**productmetrics CLI:**

```bash
productmetrics onboarding get-state --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/onboarding" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response



API response (200):

```json
{
  "data": {
    "id": 1,
    "user_id": "3e9b5c71-2f4a-4d8e-b6c0-1a2b3c4d5e6f",
    "current_step": "welcome",
    "completed_steps": [
      "welcome"
    ],
    "skipped": true,
    "completed_at": 1,
    "metadata": {
      "source": "app"
    },
    "account_type": "agency",
    "google_ads_connection_mode": "central_read_only",
    "demo_status": {
      "demo_mode_enabled": true,
      "google_ads_connected": true,
      "merchant_center_connected": true,
      "demo_completed": true,
      "has_real_workspace_property": true,
      "demo_company_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
      "demo_property_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
      "demo_company_name": "Example Store",
      "demo_property_name": "Example Store",
      "demo_profile": null
    }
  },
  "request_id": "req_01JGD0RPYTZD1YXTH69VCY3ZAF"
}
```

**CLI output:** `productmetrics onboarding get-state --json` prints `{ "ok": true, "data": …, "request_id": "…" }` with the same `data`.

## Before you call

Call this first to decide which setup step comes next. For a person who was invited to a workspace they can already open, reading the state marks onboarding complete, as opening the app does.

## Errors

A failure answers with its HTTP status and `{ error: { code, message, details? }, request_id }`. Branch on `code` (stable, lower_snake); show `message` to the person. The CLI prints the same `error` with `"ok": false`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JEPDWBHG0ASBQHSZ5S0B4RA3"
}
```

| Status | Code                 | When                                                                                                                      |
| ------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 401    | `invalid_token`      | The token is missing, expired or revoked: sign in again (`productmetrics login`). The `WWW-Authenticate` header says why. |
| 403    | `insufficient_scope` | The token lacks the `read` scope (`details.required_scope`): sign in again and allow it.                                  |
| 429    | `rate_limited`       | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Account and onboarding operations](/docs/api/account)
