Skip to content

Free slots on the connected calendar (check_calendar's backing operation)

POST
/v1/calendar/availability
curl --request POST \
--url https://api.vocapable.com/v1/calendar/availability \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "start_date": "example", "end_date": "example", "duration_minutes": 1, "timezone": "example" }'
Media typeapplication/json
CalendarAvailabilityRequest

check_calendar’s backing request - the tool’s argument schema, verbatim.

object
start_date
required
Start Date
string
/^\d{4}-\d{2}-\d{2}$/
end_date
required
End Date
string
/^\d{4}-\d{2}-\d{2}$/
duration_minutes
required
Duration Minutes
integer
>= 5 <= 240
timezone
Any of:
string
>= 1 characters <= 64 characters
Examplegenerated
{
"start_date": "example",
"end_date": "example",
"duration_minutes": 1,
"timezone": "example"
}

Successful Response

Media typeapplication/json
CalendarAvailability
object
connection_id
required
Connection Id
string
timezone
Any of:
string
slots
Slots
Array<object>
CalendarSlot
object
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
Examplegenerated
{
"connection_id": "example",
"timezone": "example",
"slots": [
{
"starts_at": "2026-04-15T12:00:00Z",
"ends_at": "2026-04-15T12:00:00Z"
}
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}