Retrieve a company

Retrieve a client company's details, payroll profile and onboarding status.

Use this endpoint to read back everything you've entered about a company, plus its onboardingStatus. It works in every onboarding status.

📘

Part of Company details. For how this fits into onboarding, see the guide: Collecting company information: checking your work.

apiKey and webhookSigningKey are never included here; they are returned only when the company is created.

For what's still missing before the company can be submitted, use Retrieve onboarding status.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
Path Params
integer
required

The company's ID, as returned when the company was created.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json