Get a connect session

Returns the session and, once it is completed, the connection it made or relinked.

GEThttps://api.bentocal.com/au/v1/connect_sessions/{connect_session_id}

Authentication

AuthorizationstringheaderBearer <token>required

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

Path parameters

1 param

connect_session_idstringrequired
Connect session id (cs_…).

Responses

A one-time link that takes an end user through connecting a calendar account.

idstringrequired
Connect session id (cs_…).
statusstringrequired
pending: created, not opened. redirected: the user went to the provider. completed: a connection was made or relinked. denied: the user declined at the provider. error: see error_code. expired: not finished in time.
user_idstringrequired
urlstringurirequired
The hosted connect page. Send the user here.
expires_atstringdate-timerequired
When the session expires (30 minutes after creation).
connectionany ofrequired
The connection made or relinked, once status is completed.
error_codestring | nullrequired
Why the session ended in error: account_mismatch (a relink signed in to a different account), connection_limit_reached, connection_not_found (the connection being relinked was deleted), session_expired or internal_error. New codes may be added.

Errors

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

{
  "id": "cs_9vB2nR7kLp4QxT1w",
  "status": "completed",
  "user_id": "user_123",
  "url": "https://api.bentocal.com/au/connect/cs_9vB2nR7kLp4QxT1w",
  "expires_at": "2026-10-15T00:30:00Z",
  "connection": {
    "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"
  },
  "error_code": null
}

Authentication

Path parameters

Responses

Was this page helpful?