Business overview - List
Paginated, sortable overview of the user's businesses for the start page table. Separate from the plain businesses list API; optional metric columns are only computed when requested.
Query Parameters
Comma-separated optional columns to include, e.g. sales,drafts,bank_count.
Comma-separated filters: vat_soon, low_automation, overdue, archived (agency users only).
Sort key, prefix with - for descending. One of: name, automation, deadline, time_saved, sales, purchase, sales_unpaid, sales_overdue, purchase_overdue, debt, drafts, docs_month, docs_year, bank_count, last_sync, luca.
A page number within the paginated result set.
Number of results to return per page.
A search term.
Response Body
application/json
curl -X GET "https://example.com/v1/business_overview/"{ "count": 123, "next": 2, "prev": 1, "size": 30, "results": [ { "id": 0, "name": "string", "slug": "string", "business_id": "string", "form": "string", "logo": "http://example.com", "is_agency_business": true, "can_archive": true, "automation_pct": 0, "next_deadline": { "property1": null, "property2": null }, "time_saved_hours": 0 } ]}Webhook subscription - Replace PUT
Previous Page
Business overview - Archive businesses POST
Bulk (un)archive of the agency's businesses, driven by the overview table's selection. Archived businesses drop out of the agency's default list and live behind the `archived` filter; the client's own users are unaffected.