The calendar connect link object

{
  "id": "ccl_01k6c0r9s8x7c2dvq3m5n6p4ab",
  "object": "calendar_connect_link",
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "member_id": null,
  "provider": "google",
  "return_url": "https://app.gurusup.com/settings/calendar",
  "client_reference_id": "gs_user_4821",
  "member_data": {
    "name": "Ana García",
    "email": "ana@acme.com",
    "metadata": { "gurusup_user_id": "gs_user_4821" }
  },
  "url": "https://api.meetingkit.com/connect/calendar/ccl_01k6c0r9s8x7c2dvq3m5n6p4ab?token=…",
  "expires_at": "2026-09-23T10:10:00Z",
  "status": "open",
  "calendar_connection_id": null,
  "error": null,
  "created_at": "2026-09-22T10:10:00Z"
}

{
  "id": "ccl_01k6c0r9s8x7c2dvq3m5n6p4ab",
  "object": "calendar_connect_link",
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "member_id": null,
  "provider": "google",
  "return_url": "https://app.gurusup.com/settings/calendar",
  "client_reference_id": "gs_user_4821",
  "member_data": {
    "name": "Ana García",
    "email": "ana@acme.com",
    "metadata": { "gurusup_user_id": "gs_user_4821" }
  },
  "url": "https://api.meetingkit.com/connect/calendar/ccl_01k6c0r9s8x7c2dvq3m5n6p4ab?token=…",
  "expires_at": "2026-09-23T10:10:00Z",
  "status": "open",
  "calendar_connection_id": null,
  "error": null,
  "created_at": "2026-09-22T10:10:00Z"
}

A connect link sends one of your users through Google or Microsoft consent and brings them back to your product. It lives 24 hours. See Connect calendars.

Attributes

string

Stable typed ID beginning with ccl_.

string

Always calendar_connect_link.

string

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

string | null

The member connecting, or null to create the member from the connected account.

string

google: Google Calendar.
microsoft: Microsoft Outlook calendar.

string

Where the browser returns after consent, with the outcome in the query string.

string | null

Your own reference, returned on the redirect.

object | null

The member the consent creates, as you sent it (metadata is {} when you sent none), or null.

Show properties

string

The member’s name. A person who already has a MeetingKit account keeps their own.

string

Pre-fills the provider’s account chooser. A hint, never a check.

object

Set on the member when it is created, or merged into an existing member’s.

string | null

The link to send the user to. null once it can no longer be opened.

string

When the link stops working, 24 hours after it was created.

string

open: Waiting for the user, including after they declined consent.
completed: The user connected their calendar.
failed: It could not connect. error says why.
expired: 24 hours went by.

string | null

The connection it made, once status is completed.

object | null

Why the link failed, or null.

Show properties

string

access_denied, link_expired, link_used, account_mismatch, calendar_already_connected, account_in_use, not_authorized, connect_failed

string

What happened.

string

When the link was created, in ISO 8601.

{
  "id": "ccl_01k6c0r9s8x7c2dvq3m5n6p4ab",
  "object": "calendar_connect_link",
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "member_id": null,
  "provider": "google",
  "return_url": "https://app.gurusup.com/settings/calendar",
  "client_reference_id": "gs_user_4821",
  "member_data": {
    "name": "Ana García",
    "email": "ana@acme.com",
    "metadata": { "gurusup_user_id": "gs_user_4821" }
  },
  "url": "https://api.meetingkit.com/connect/calendar/ccl_01k6c0r9s8x7c2dvq3m5n6p4ab?token=…",
  "expires_at": "2026-09-23T10:10:00Z",
  "status": "open",
  "calendar_connection_id": null,
  "error": null,
  "created_at": "2026-09-22T10:10:00Z"
}

Overview

Endpoints

The calendar connect link object

Attributes

​Attributes

Attributes