API reference
Every endpoint, generated from the OpenAPI document, with the playground.
These pages are generated from the API's OpenAPI 3.1 document, so they always match the code. Download the document from /openapi.json to generate clients and SDKs.
Playground
Every page has a playground to try the request from your browser. Requests go through a proxy on this site, which only forwards to the Getbeel API and does not log bodies.
Use a test key
In the Authorization field enter Bearer gb_test_…. The playground runs in
your browser: don't paste a live key into it.
Conventions
- Base URL:
https://www.getbeel.com/api/v1. - Authentication: API key in the
Authorizationheader. - Errors: common shape
{ "error": { type, code, message, param } }. - Lists: cursor pagination.
POSTrequests that create or send:Idempotency-Keyheader.
CLI
Send invoices, upload bank statements and check deadlines from the terminal.
The prepaid balance GET
Spendable balance (expired credit excluded), credit expiring in 30 days, auto top-up and low-balance alert settings (the alert email starts once there is paid credit: a top-up), pricing, and welcome_credit: whether the €1 welcome credit was granted and, if not, why (card_already_used: it applies only once per card). pricing is pay_as_you_go for an account that signed up on or after 13 November 2026, or legacy_plan for one that signed up before: it keeps its plan and everything it includes, nothing is paid from a balance, the amounts are 0 and topup_url is null. A client company (Getbeel-Company) sees its gestore’s balance with billed_to_parent true. Usage, top-ups and card links answer 409 not_pay_as_you_go for a legacy_plan account.