Connect a mailbox
gmail / outlook: 200 with a link to the OAuth consent; the user opens it in a browser signed in to getbeel and lands back in the app (the connection then shows in GET /connections). imap: tests the login (port 993, TLS) and saves the mailbox, 201. Counts toward the plan mailbox limit (402). Live keys only (403 livemode_required with a test key): bank and connection data is real, there is no sandbox for it.
gmail / outlook: 200 with a link to the OAuth consent; the user opens it in a browser signed in to getbeel and lands back in the app (the connection then shows in GET /connections). imap: tests the login (port 993, TLS) and saves the mailbox, 201. Counts toward the plan mailbox limit (402). Live keys only (403 livemode_required with a test key): bank and connection data is real, there is no sandbox for it.
apiKeyAuthorizationBearer <token>API key: gb_test_… or gb_live_…
Getbeel-Company?stringAct on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.
uuidapplication/json- body
provider*stringReturns a link: the user opens it, signs in to getbeel if needed, approves access and lands back in the app
"gmail""outlook"OK
application/json- response
object*stringprovider*string"gmail""outlook""stripe"url*stringOpen in a browser signed in to getbeel as a member of this team (it asks to sign in otherwise). After approving, the user lands back in getbeel.
uricurl -X POST 'https://www.getbeel.com/api/v1/connections/email' \ -H 'Content-Type: application/json' \ -d '{ "provider": "gmail"}'{ "object": "connection_link", "provider": "gmail", "url": "http://example.com"}List mailbox, forwarding and Stripe connections GET
Pagina precedente
Scan a mailbox for invoices in a date range POST
Gmail, Outlook or IMAP; at most 366 days. Runs in the background (202); found invoices appear in GET /received-invoices with source email (webhook received_invoice.created). Live keys only (403 livemode_required with a test key): bank and connection data is real, there is no sandbox for it.