API Reference / Get setup status
Get setup status
Where a new account is in setup (website, researching, review, payment, start or done) and the exact next step. Works before the account has paid.
Last updated
The customer's own AI agent sets a new account up with the setup routes: give Revnu the website, confirm what research found, open checkout, then start. This call says where the account is and what to do next. The recipe agents follow is at revnu.com/setup.md.
curl -H "Authorization: Bearer $REVNU_API_TOKEN" https://revnu.com/api/v1/setupResponse
{ "setup": { "stage": "review", "next": "Show the customer what Revnu understood…", "account": { "name": "Acme", "website": "https://acme.com" }, "dashboardUrl": "https://revnu.com/dashboard", "review": { "businessName": "Acme", "researchFailed": false, "rows": [{ "id": "sells", "kind": "fact", "label": "What You Sell", "found": "Invoicing for agencies", "sources": ["https://acme.com"], "required": true }] } } }stage is one of website, researching, review, payment, start and done. researching adds research (the current step and findings so far); review adds review.rows; payment adds payment (price, trial days). Follow next.
Agents: this page is also markdown at /docs/setup-status.md, answers Accept: text/markdown, and is listed in /docs/llms.txt.
Frequently Asked Questions
None. Any token on the account can read its setup, including one approved before the account has paid. Until the first subscription, every route except `/me` and the setup routes answers `402` with `error: "setup_pending"`.