Get the business onboarding todo flags

Overview

Returns the full set of onboarding todo flags for the business in context.

Before responding, the server refreshes the flags from live business data — for example todo_clients becomes done once the business has more than 5 clients, todo_invoice once any invoice exists, todo_payments once a payment gateway or payment wallet app is connected, todo_staff once more than one staff member exists, and todo_website once the site has been published. The refreshed values are persisted, so the response is always the authoritative current state.

Available for Staff & Directory tokens. Directory tokens MUST send the business in the X-On-Behalf-Of header (a Directory token without it is rejected with 403).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string

The business UID to act on behalf of. Required when authenticating with a Directory token; not needed for a Staff token (e.g., "fyclhomrzdspdyk6").

Responses

401

Missing or invalid access token.

403

The token is not allowed to access this business — for example a Directory token sent without the X-On-Behalf-Of header, or a staff member without admin account access.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json