Spaces

Your data is organised in spaces: your personal space and any space someone shared with you. Endpoints that work on one take an optional space parameter.

What a space is

A space holds a set of accounts and everything recorded on them: transactions, categories, labels, automation rules and savings goals. Everyone has a personal space, and a space can be shared with other people.

The API gives you exactly what the app gives you: your own data. In a space you share, you read and change only the accounts, transactions, categories, labels, rules and goals you created, and every id you send must point at one of yours. Another member's object answers 404, exactly like one that does not exist.

List the spaces you can reach, with their ids:

curl https://whisper.money/api/v1/spaces \
  -H "Authorization: Bearer $WHISPER_MONEY_TOKEN"

The space parameter

Endpoints that read or write data inside a space accept an optional space parameter with a space id. Leave it out and the endpoint works on your personal space.

On a GET, send it in the query string:

GET /api/v1/accounts?space=0199a3f2-6c1e-7b4d-9a8e-2f5c1d3b4a60

On a POST, PATCH, PUT or DELETE, send it in the query string or in the JSON body.

An id you have no access to answers 422, with the error under space. The reference lists space among the parameters of every endpoint that takes it.

An object's id is looked up in that space too. To read or change an account, a transaction, a category, a label, an automation rule or a savings goal of a shared space, send that space's id along with it: without it, the object is looked for in your personal space and answers 404.

Budgets, analytics and achievements ignore space: they cover your whole account rather than one space, as they do in the app. Sending it anyway is not an error, but it changes nothing.