Skip to main content

Link

A scheduling link for booking appointments

default_durationintegerrequired

Default meeting duration in minutes

descriptionstringnullable

Link description

durationsinteger[]required

Available meeting durations in minutes

fieldsobject[]required

Custom fields for this link

idstringrequired

Unique link identifier (opaque ID)

incrementintegerrequired

Time slot increment in minutes

namestringrequired

Public link name

private_namestringnullable

Private link name (only visible to owner)

scope objectnullable

Associated scope/team (if any)

idstringrequired

Scope ID

namestringrequired

Scope name

slugstringrequired

Scope slug

slugstringrequired

URL slug for the link

statestringrequired

Link state

Possible values: [active, disabled]

Link
{
"default_duration": 30,
"description": "A brief meeting to discuss your needs",
"durations": [
15,
30,
45
],
"fields": [
{
"id": "field_123",
"is_required": true,
"label": "Company",
"type": "text"
}
],
"id": "link_abc123",
"increment": 15,
"name": "30 Minute Meeting",
"private_name": "Quick sync with prospects",
"scope": {
"id": "scope_xyz789",
"name": "Sales Team",
"slug": "sales"
},
"slug": "30min",
"state": "active"
}