Skip to main content

Overview

Retrieves all calendar connections associated with your platform. This shows which users have authorized their Google Calendar through your integration.

Authentication

Requires Platform API Key in the Authorization header or X-API-Key header.

Request

No Parameters Required

This endpoint returns all calendar connections for the authenticated platform.

Response

Success Response (200 OK)

Response Fields

boolean
Whether the request succeeded
array
Array of calendar connection objects
string
Email address of the connected user
string
Google account ID for the user
string
Calendar provider (currently only "google")
string
ISO 8601 timestamp when the user first connected
string
ISO 8601 timestamp of last API usage for this user
boolean
Whether the user completed the onboarding flow
string
User’s configured timezone (IANA format)
number
Total number of connections returned

Example

Security Note

OAuth tokens are sanitized - This endpoint does not return OAuth access tokens or refresh tokens. It only returns connection metadata for security reasons. To use a user’s calendar:
  1. Get their email from this endpoint
  2. Use their email in scheduling API calls
  3. Syncline handles OAuth token management internally

Use Cases

Track Active Users

Monitor which users have connected their calendars:

User Onboarding Status

Check if specific users have completed setup:

Analytics Dashboard

Build dashboards showing connection statistics:

Error Responses

error
Invalid or missing API key
error
Failed to retrieve connections from database

Disconnect Calendar

Remove a calendar connection

Platform Dashboard

View platform analytics