---
title: "Read the active workspace's first-start guide state"
method: GET
path: "/first-start-guide"
tags: ["Onboarding"]
---

# Read the active workspace's first-start guide state

`GET /first-start-guide`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/first-start-guide`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Returns the selected workspace type and channel, whether its guide remains available in navigation, whether an empty company should open it automatically, and the signed-in user's Getting Started and guided-tour invitation preferences. An undismissed Pro firm workspace can use this response to launch accountant onboarding.

## Response `200`

First-start guide visibility, preference, and company context

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/01c3e57d281f?raw)