HAhappyscribe
Calendar connections

Get a calendar connection

get/calendar_connections/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Response

The connection.

idstring

Stable typed ID beginning with cal_. Treat it as an opaque string.

objectstring

Always calendar_connection.

workspace_idstring

Workspace ID, beginning with wks_. Treat it as an opaque string.

member_idstring

The member whose calendar this is.

provider'google' | 'microsoft'

The connected calendar.

  • google: Google Calendar.
  • microsoft: Microsoft Outlook calendar.
status'active' | 'error' | 'disconnected'
  • active: syncing.
  • error: the account stopped granting access; send the member a new connect link.
  • disconnected: disconnected by you or in HappyScribe, or the member was removed.
account_emailstring nullable

The email of the connected Google or Microsoft account.

connected_atstring date-time nullable

When the member last finished consent, in ISO 8601.

last_synced_atstring date-time nullable

When the calendar last synced, in ISO 8601.

created_atstring date-time

When the connection was first made, in ISO 8601.

Example response

{
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab"
}

Changes

No recorded changes to this operation across all 1 revision of this API.