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).
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Missing or invalid access token.
403The 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.
