Get a connection

Returns one connection.

GEThttps://api.bentocal.com/au/v1/connections/{connection_id}

Authentication

AuthorizationstringheaderBearer <token>required

An API key: bc_{live|test}_{region}_…, from the console.

Path parameters

1 param

connection_idstringrequired
Connection id (conn_…).

Responses

One end user's link to one Google or Microsoft account.

idstringrequired
Connection id (conn_…).
user_idstringrequired
Your identifier for the end user who owns the connection.
providerstringgoogle | microsoftrequired
emailstring | nullrequired
The provider account's email address.
display_namestring | nullrequired
The provider account's display name.
statusstringactive | relink_required | revokedrequired
active: usable. relink_required: the provider stopped accepting the stored grant; send the user through a connect session with connection_id to fix it. revoked: disconnected for good.
primary_calendar_idstring | nullrequired
The provider's id for the account's primary calendar.
connected_atstringdate-timerequired
When the connection was first made.
last_used_atany ofrequired

Errors

curl -X GET "https://api.bentocal.com/au/v1/connections/<connection_id>" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "id": "conn_4kT9pQ2vXa7LmN3s",
  "user_id": "user_123",
  "provider": "google",
  "email": "sam@example.com",
  "display_name": "Sam Lee",
  "status": "active",
  "primary_calendar_id": "sam@example.com",
  "connected_at": "2026-10-01T03:12:45Z",
  "last_used_at": "2026-10-14T22:01:09Z"
}

Authentication

Path parameters

Responses

Was this page helpful?