Riferimento API
Ogni endpoint, generato dal documento OpenAPI, con il playground.
Queste pagine sono generate dal documento OpenAPI 3.1 dell'API, quindi sono sempre allineate al codice. Il documento è scaricabile da /openapi.json per generare client e SDK.
Le descrizioni degli endpoint sono in inglese, come i nomi dei campi.
Playground
Ogni pagina ha un playground per provare la richiesta dal browser. Le richieste passano da un proxy di questo sito, che inoltra solo all'API di Getbeel e non registra i corpi.
Usa una chiave di test
Nel campo Authorization scrivi Bearer gb_test_…. Il playground gira nel
tuo browser: non incollarci una chiave live.
Convenzioni
- URL di base:
https://www.getbeel.com/api/v1. - Autenticazione: chiave API nell'header
Authorization. - Errori: forma comune
{ "error": { type, code, message, param } }. - Elenchi: paginazione a cursore.
POSTche creano o inviano: headerIdempotency-Key.
CLI
Invia fatture, carica estratti conto e controlla le scadenze dal terminale.
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.