OpenAssistantAPI
→

User API

Booking Links

Scheduling links

POST/booking-links

Create booking link

Request body

slug reqstring
titlestring
activeboolean
meetingTypeenumvirtualin_person
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring

Responses

201Created
ok reqenumtrue
bookingLink reqobject
id reqstring
account reqstring
user reqstring
slugstring | null
isPrimaryboolean
titlestring | null
active reqboolean
meetingTypeenumvirtualin_person
timezonestring | null
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
shareToken reqstring
inviteesobject[]
id reqstring
name reqstring
email reqstring
statusenumpendingbooked
invitedAt reqstring
bookedAt reqstring | null
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/booking-links' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string"
}'

Response

{
  "ok": true,
  "bookingLink": {
    "id": "string",
    "account": "string",
    "user": "string",
    "active": true,
    "shareToken": "string",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
GET/booking-links/{bookingLinkId}

Get booking link

Path parameters

bookingLinkId reqstring

Responses

200Link
ok reqenumtrue
bookingLink reqobject
id reqstring
account reqstring
user reqstring
slugstring | null
isPrimaryboolean
titlestring | null
active reqboolean
meetingTypeenumvirtualin_person
timezonestring | null
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
shareToken reqstring
inviteesobject[]
id reqstring
name reqstring
email reqstring
statusenumpendingbooked
invitedAt reqstring
bookedAt reqstring | null
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/booking-links/<bookingLinkId>' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "bookingLink": {
    "id": "string",
    "account": "string",
    "user": "string",
    "active": true,
    "shareToken": "string",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
PUT/booking-links/{bookingLinkId}

Update booking link

Path parameters

bookingLinkId reqstring

Request body

slugstring
titlestring
activeboolean
meetingTypeenumvirtualin_person
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring

Responses

200Updated
ok reqenumtrue
bookingLink reqobject
id reqstring
account reqstring
user reqstring
slugstring | null
isPrimaryboolean
titlestring | null
active reqboolean
meetingTypeenumvirtualin_person
timezonestring | null
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
shareToken reqstring
inviteesobject[]
id reqstring
name reqstring
email reqstring
statusenumpendingbooked
invitedAt reqstring
bookedAt reqstring | null
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/booking-links/<bookingLinkId>' \
  -X PUT \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string",
  "title": "string",
  "active": true,
  "meetingType": "virtual"
}'

Response

{
  "ok": true,
  "bookingLink": {
    "id": "string",
    "account": "string",
    "user": "string",
    "active": true,
    "shareToken": "string",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
DELETE/booking-links/{bookingLinkId}

Delete booking link

Path parameters

bookingLinkId reqstring

Responses

200Deleted
ok reqenumtrue
bookingLink reqobject
id reqstring
deletedboolean
messagestring

Request

curl 'https://app.openassistant.us/api/booking-links/<bookingLinkId>' \
  -X DELETE \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "bookingLink": {
    "id": "string"
  }
}
POST/booking-links/{bookingLinkId}/invitees

Add invitees to an invite_only booking link

Path parameters

bookingLinkId reqstring

Request body

invitees reqobject[]
name reqstring
email reqstring

Responses

200Updated
ok reqenumtrue
bookingLink reqobject
id reqstring
account reqstring
user reqstring
slugstring | null
isPrimaryboolean
titlestring | null
active reqboolean
meetingTypeenumvirtualin_person
timezonestring | null
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
shareToken reqstring
inviteesobject[]
id reqstring
name reqstring
email reqstring
statusenumpendingbooked
invitedAt reqstring
bookedAt reqstring | null
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/booking-links/<bookingLinkId>/invitees' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "invitees": [
    {
      "name": "string",
      "email": "string"
    }
  ]
}'

Response

{
  "ok": true,
  "bookingLink": {
    "id": "string",
    "account": "string",
    "user": "string",
    "active": true,
    "shareToken": "string",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
DELETE/booking-links/{bookingLinkId}/invitees/{inviteeId}

Remove a booking link invitee

Path parameters

bookingLinkId reqstring
inviteeId reqstring

Responses

200Updated
ok reqenumtrue
bookingLink reqobject
id reqstring
account reqstring
user reqstring
slugstring | null
isPrimaryboolean
titlestring | null
active reqboolean
meetingTypeenumvirtualin_person
timezonestring | null
offerTimesStartingDaysnumber
notSoonerThanMinutesnumber
atLatestDaysnumber
instructionsstring | null
chatEnabledboolean
accessModeenumpublicanyone_with_linkinvite_only
shareToken reqstring
inviteesobject[]
id reqstring
name reqstring
email reqstring
statusenumpendingbooked
invitedAt reqstring
bookedAt reqstring | null
schedulingPreferencesobject
syncboolean
availabilityobject
syncboolean
workingHoursobject
MOobject[]
startstring
endstring
TUobject[]
startstring
endstring
WEobject[]
startstring
endstring
THobject[]
startstring
endstring
FRobject[]
startstring
endstring
SAobject[]
startstring
endstring
SUobject[]
startstring
endstring
workingHolidaysstring[]
customHolidaysstring[]
holidayCountriesstring[]
holidayCountrystring
defaultsobject
syncboolean
virtualobject
durationnumber
defaultMeetingLinkstring
conferenceSolutionstring
conferenceIntegrationstring
inPersonobject
durationnumber
defaultLocationstring
calendarsobject
syncboolean
readstring[]
writestring
buffersobject
syncboolean
bufferTypeenumnonemeetingtimeBlock
bufferLengthnumber
bufferBlockLengthnumber
dailyMeetingLimitnumber
customEventTitlesobject
internalobject
useCustomTitlesboolean
solostring
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
externalobject
useCustomTitlesboolean
oneAttendeestring
twoAttendeesstring
manyAttendeesstring
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/booking-links/<bookingLinkId>/invitees/<inviteeId>' \
  -X DELETE \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "bookingLink": {
    "id": "string",
    "account": "string",
    "user": "string",
    "active": true,
    "shareToken": "string",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/booking-links/{bookingLinkId}/invitees/{inviteeId}/invite

Send (or re-send) a booking link invitee their personal link

Path parameters

bookingLinkId reqstring
inviteeId reqstring

Responses

200Sent
ok reqboolean

Request

curl 'https://app.openassistant.us/api/booking-links/<bookingLinkId>/invitees/<inviteeId>/invite' \
  -X POST \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true
}