Get calendar connection

GET

/api/calendar-connections/{connectionId}

• Production

Retrieve a single calendar connection by its identifier.

Authorizations

• bearerAuth

Parameters

Path Parameters

connectionId

required

string format: uuid

The unique identifier of the calendar connection.

Responses

200

The calendar connection was found and returned.

A calendar connection links a Google calendar to a workspace via OAuth.

object

id

required

Unique identifier for the calendar connection.

string format: uuid

Example

cal_11223344-5566-7788-99aa-bbccddeeff00

workspaceId

required

The workspace this connection belongs to.

string format: uuid

Example

a1b2c3d4-e5f6-7890-abcd-ef1234567890

provider

required

Calendar provider: google.

string

Example

google

displayName

required

Human-readable name for the connection.

string

Example

Sales Team Calendar

calendarId

Calendar identifier from the provider.

string | null

Example

sales@example.com

enabled

required

Whether the connection is active.

boolean

Example

true

bookingConfig

Scheduling configuration.

object

workingHours

Per-day start and end times.

object

key

additional properties

object

start

string

Example

09:00

end

string

Example

17:00

bufferMinutes

Minimum buffer between consecutive bookings.

integer

Example

15

timezone

IANA timezone identifier.

string

Example

UTC

blockedDates

Dates in YYYY-MM-DD format when no bookings are accepted.

Array<string>

Example

[
  "2026-12-24",
  "2026-12-25",
  "2026-12-31"
]

createdAt

required

string format: date-time

Example

2026-03-10T08:00:00.000Z

updatedAt

required

string format: date-time

Example

2026-03-12T14:20:00.000Z

404

No calendar connection exists with the given ID.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found

code

A machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.

string

Example

key_lock

missing_scopes

On a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.

Array<string>

Example

[
  "mcp:write"
]

entryId

On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.

string format: uuid

Example

11223344-5566-4788-99aa-bbccddeeff00

connectionId

On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.

string

undeclaredTools

On the same 422: the tool names the connection does not declare.

Array<string>

Example

[
  "get_orders"
]

declaredTools

On the same 422: the tools the connection declares.

Array<string>

Example

[
  "get_order",
  "search_orders"
]