Onboarding

Read the active workspace's first-start guide state

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.

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

Response

First-start guide visibility, preference, and company context

Changes

No recorded changes to this operation across all 3 revisions of this API.