GetbeelDocs
API referenceConnections

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.

POST
/connections/email

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.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Header Parameters

Getbeel-Company?string

Act 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.

Formatuuid

Request Body

application/json
  1. body
provider*string

Returns a link: the user opens it, signs in to getbeel if needed, approves access and lands back in the app

Value in"gmail""outlook"

Response Body

OK

application/json
  1. response
object*string
provider*string
Value in"gmail""outlook""stripe"
url*string

Open 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.

Formaturi
Example Request
curl -X POST 'https://www.getbeel.com/api/v1/connections/email' \  -H 'Content-Type: application/json' \  -d '{  "provider": "gmail"}'
Example Response
{  "object": "connection_link",  "provider": "gmail",  "url": "http://example.com"}