What the API does not do
Read this before you plan an integration.
No writes
The API is read-only. It can't create, change or delete budgets, categories, expenses or vendors. Do these in the Spendbaker app.
Only what you can see
- A key reads what its user sees in the app, nothing more. A budget nobody shared with you stays hidden, even from an admin.
- There is no organization-wide view yet: only personal access keys are available. Organization access keys are coming (see Authentication).
- Expenses are listed for active budgets only.
Data left out
- Ads integrations, their campaigns and their detailed ad spend.
- The ROI analyzer.
- The activity log.
- Invitations, and members who haven't joined yet.
- Contact details: members' email and phone, vendors' email.
No push
There are no webhooks or events: the API doesn't tell you when something changes. Read it again on a schedule, within the rate limit.
Simple lists
- Lists come in a fixed order: there are no sort options.
- There is no full-text search. Filters are the ones listed on each route, such as the expense filters.
- There are no totals per period beyond what a budget and its categories return. Sum expenses yourself, with
budget_amount. - There is no export to CSV or Excel.
No browser calls and no sandbox
- Call the API from a server or a script. Browsers can't call it from another website (CORS), and a key in a web page would leak.
- There is no test environment: a key reads your organization's real data. It can't change it, though.