---
title: "Get a company's onboarding checklist"
method: GET
path: "/companies/{companyId}/onboarding"
tags: ["Client Onboarding"]
---

# Get a company's onboarding checklist

`GET /companies/{companyId}/onboarding`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/companies/{companyId}/onboarding`
- 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 firm-started onboarding checklist for a managed company, or onboarding:null when none was started (a website signup keeps its own onboarding record). Six steps: client details, engagement letter, billing, client portal, books setup, finish. Each step reports done, not needed, or open, and whether it was detected automatically or marked by hand. Amounts are integer cents.

## Path parameters

- `companyId` string, uuid, required

## Response `200`

{onboarding: checklist | null}

## 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/9a8269f0a586?raw)
