Skip to main content
GET
Get a calendar widget

Authorizations

Authorization
string
header
required

A Sorraia API key created in the dashboard (Settings → Integrations, under Programmatic API access). Pass it as Authorization: Bearer sor_live_.... API access is included with every paid plan; a key whose account is on the Free plan receives 402 plan_feature_gated.

Path Parameters

id
integer
required

The resource id.

Response

The calendar widget.

id
integer
required
name
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
domain
object | null

The registered domain a resource is bound to.

bookingCount
integer

Present on list responses.

settings
object

Widget settings (webhookUrl stripped). Present on the detail view. Includes locale — the language visitors see, a canonical BCP-47 tag such as it-IT or nl-NL — when one is set; a calendar without it is shown in en-US. It covers the widget, the times the AI chat offers and the visitor's booking emails. A booking's slotDisplay is not affected.

appearance
object

Present on the detail view.

behavior
object

Present on the detail view.