Skip to content
vocapable.Docs

A host's calendar state and open times for a day

GET
/v1/workspace/meetings/availability
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/meetings/availability?host_user_id=example&day=2026-04-15&timezone=example&duration_minutes=30' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
host_user_id
required
Host User Id
string
<= 64 characters
day
required
Day
string format: date
timezone
required
Timezone
string
>= 1 characters <= 64 characters
duration_minutes
Duration Minutes
integer
default: 30 >= 5 <= 480
start_at
Any of:
string format: date-time
exclude_meeting_id
Any of:
string
<= 64 characters
event_type
Any of:
string
<= 500 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceMeetingAvailability
object
host
required
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
calendar
required
WorkspaceHostCalendar

What a host’s calendar can do for a booking, stated exactly.

object
state
required
State
string
Allowed values: connected not_connected not_assigned awaiting_review needs_admin_consent reauthorization_required attention_needed paused
provider
required
Any of:
string
Allowed values: google_calendar microsoft_calendar calendly
provider_name
required
Any of:
string
account_label
required
Any of:
string
installation_id
required
Any of:
string
calendars
required
Calendars
Array<object>
WorkspaceCalendarChoice
object
id
required
Id
string
label
required
Label
string
writable
required
Writable
boolean
write_calendar_id
required
Any of:
string
working_hours
required
Working Hours
object
key
additional properties
Array<Array<string>>
buffer_before_minutes
required
Buffer Before Minutes
integer
buffer_after_minutes
required
Buffer After Minutes
integer
timezone
required
Any of:
string
event_types
required
Event Types
Array<object>
WorkspaceEventTypeChoice
object
id
required
Id
string
label
required
Label
string
duration_minutes
required
Any of:
integer
event_type_booking
required
Any of:
string
admin_consent_url
required
Any of:
string
detail
required
Detail
string
connect_path
required
Connect Path
string
day
required
Day
string format: date
timezone
required
Timezone
string
checked_at
required
Any of:
string format: date-time
busy
required
Busy
Array<object>
WorkspaceBusyRange
object
start
required
Start
string format: date-time
end
required
End
string format: date-time
source
required
Source
string
Allowed values: calendar meeting
meeting_id
Any of:
string
label
Any of:
string
slots
required
Slots
Array<object>
WorkspaceMeetingSlot
object
start
required
Start
string format: date-time
end
required
End
string format: date-time
proposed
required
Any of:
WorkspaceProposedTime
object
start
required
Start
string format: date-time
end
required
End
string format: date-time
clear
required
Clear
boolean
conflicts
required
Conflicts
Array<object>
WorkspaceBusyRange
object
start
required
Start
string format: date-time
end
required
End
string format: date-time
source
required
Source
string
Allowed values: calendar meeting
meeting_id
Any of:
string
label
Any of:
string
within_working_hours
required
Within Working Hours
boolean
provider_error
required
Any of:
string
Example
{
  "calendar": {
    "state": "connected",
    "provider": "google_calendar"
  },
  "busy": [
    {
      "source": "calendar"
    }
  ],
  "proposed": {
    "conflicts": [
      {
        "source": "calendar"
      }
    ]
  }
}

422

Section titled “422”

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": {}
    }
  ]
}