budget

Get the budget and brake state

The account budget (amount, period, the derived daily and monthly caps, currency) and the state of its Emergency Brake: whether it is armed, whether it is currently engaged, and the events it has recorded, including exactly which campaigns each one paused.

The Emergency Brake pauses campaigns automatically when real month-to-date spend passes the budget. It uses the campaign scopes, so any token that can read campaigns can read it.

get/api/v1/budget

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/budget
  • Auth: HTTP bearer

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.