HTTP API
ReferenceMeetings API
Endpoints for meetings and their occurrences, notes and attendance, scheduled calls in chats, and groups.
This group covers meetings and their occurrences, shared notes and attendance, the scheduled calls of a chat, and groups and their members. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope Volobox). An integration app's own client secret is refused with 403 (Volobox:Integrations:MemberConnectionRequired). Paths, tokens and conventions are in API overview.
Groups
GET/api/v1/group
Lists the groups the caller can see, filtered and paged.
meetings.group.getList
POST/api/v1/group
Creates a group with the caller as its admin.
meetings.group.create
GET/api/v1/group/{id}
Gets a group the caller can see.
meetings.group.get
PUT/api/v1/group/{id}
Updates the details of a group the caller administers.
meetings.group.update
DELETE/api/v1/group/{id}
Deletes a group the caller administers.
meetings.group.delete
POST/api/v1/group/{id}/leave
Takes the caller out of a group.
meetings.group.leave
DELETE/api/v1/group/{id}/member-entries/{memberId}
Removes one member entry, a person or an agent, from a group the caller administers.
meetings.group.removeMemberEntry
GET/api/v1/group/{id}/members
Lists the members of a group the caller can see.
meetings.group.getMembers
POST/api/v1/group/{id}/members
Adds a workspace member to a group the caller administers.
meetings.group.addMember
PUT/api/v1/group/{id}/members/{memberId}
Changes the role of a member of a group the caller administers.
meetings.group.updateMember
DELETE/api/v1/group/{id}/members/{userId}
Removes a person from a group the caller administers.
meetings.group.removeMember
GET/api/v1/group/for-user/{userId}
Lists the groups a workspace member belongs to that the caller can see.
meetings.group.getForUser
GET/api/v1/group/my-groups
Lists the groups the caller is a member of. Acts on the signed-in person's own account.
meetings.group.getMyGroups
Request bodies:
CreateGroupDto(create): requiresname(string).UpdateGroupDto(update): requiresname(string).UpdateGroupMemberDto(updateMember): requiresrole(GroupMemberRole: None, Viewer, Member, Manager, Admin).
Meetings
GET/api/v1/meeting
Lists the meetings of one category the caller can see (for example the ones they take part in), optionally within a date range.
meetings.meeting.getList
POST/api/v1/meeting
Creates a meeting with its time, participants, audience and conference link.
meetings.meeting.create
GET/api/v1/meeting/{id}
Gets a meeting the caller can see.
meetings.meeting.get
PUT/api/v1/meeting/{id}
Updates a meeting the caller may manage.
meetings.meeting.update
DELETE/api/v1/meeting/{id}
Deletes a meeting the caller may manage.
meetings.meeting.delete
GET/api/v1/meeting/{id}/attendance
Lists who attended a meeting, or one occurrence of a recurring meeting, as its conference provider reported it.
meetings.meeting.getAttendance
PUT/api/v1/meeting/{id}/audience
Changes who can see a meeting the caller may manage.
meetings.meeting.setAudience
POST/api/v1/meeting/{id}/invite
Invites workspace members to a meeting: the organizer always may, a participant on an open meeting, or on a private one whose organizer lets guests invite others.
meetings.meeting.invite
POST/api/v1/meeting/{id}/leave
Takes the caller off a meeting's participants.
meetings.meeting.leave
POST/api/v1/meeting/{id}/mark-joined
Records that the caller joined a meeting, or one occurrence of it.
meetings.meeting.markJoined
GET/api/v1/meeting/{id}/notes
Gets the shared notes of a meeting the caller can see.
meetings.meeting.getNotes
PUT/api/v1/meeting/{id}/notes
Updates the shared notes of a meeting.
meetings.meeting.updateNotes
GET/api/v1/meeting/{id}/occurrence
Gets one occurrence of a recurring meeting, with its own changes applied.
meetings.meeting.getOccurrence
PUT/api/v1/meeting/{id}/occurrence
Changes one occurrence of a recurring meeting without changing the series.
meetings.meeting.updateOccurrence
POST/api/v1/meeting/{id}/occurrence/cancel
Cancels one occurrence of a recurring meeting.
meetings.meeting.cancelOccurrence
POST/api/v1/meeting/{id}/occurrence/restore
Restores a cancelled occurrence of a recurring meeting.
meetings.meeting.restoreOccurrence
POST/api/v1/meeting/{id}/response
Records the caller's answer (yes, no or maybe) to a meeting, or to one occurrence of it.
meetings.meeting.respond
GET/api/v1/meeting/attendance/active-users
Lists the people in a meeting right now: those a conference provider reports, and those invited to an in-person meeting while it runs.
meetings.meeting.getActiveAttendance
POST/api/v1/meeting/check-availability
Checks whether the proposed participants are free at a proposed meeting time.
meetings.meeting.checkAvailability
GET/api/v1/meeting/conference-options
Lists the conference providers the caller can use for a meeting, and which one is the default.
meetings.meeting.getConferenceOptions
GET/api/v1/meeting/live
Lists the scheduled meetings the caller can see that are running now or about to start, with a join link.
meetings.meeting.getLive
POST/api/v1/meeting/quick-conference-link
Creates a conference link on a chosen provider for a meeting held right away.
meetings.meeting.generateQuickConferenceLink
Request bodies:
CreateMeetingDto(create): requiresstartTime(date-time),title(string).UpdateMeetingDto(update): requiresstartTime(date-time),title(string).UpdateMeetingNotesDto(updateNotes): no field is required.UpdateOccurrenceDto(updateOccurrence): requiresoccurrenceStartUtc(date-time),startTime(date-time),title(string).
Scheduled calls
GET/api/v1/scheduled-talk/{id}
Gets a scheduled call the caller can see.
meetings.scheduledTalk.get
POST/api/v1/scheduled-talk/{id}/cancel
Cancels a scheduled call that the caller may change.
meetings.scheduledTalk.cancel
POST/api/v1/scheduled-talk/{id}/subscribe
Asks to be notified when a scheduled call starts.
meetings.scheduledTalk.subscribe
DELETE/api/v1/scheduled-talk/{id}/subscribe
Stops the caller's notification for a scheduled call.
meetings.scheduledTalk.unsubscribe
PUT/api/v1/scheduled-talk/{id}/time
Moves a scheduled call to a new time, or to now.
meetings.scheduledTalk.reschedule
GET/api/v1/scheduled-talk/conversations/{conversationId}
Lists the scheduled calls of a chat that have not ended yet.
meetings.scheduledTalk.getLiveForConversation
POST/api/v1/scheduled-talk/conversations/{conversationId}
Schedules a call in a chat at a given time, or starts one now when no time is given.
meetings.scheduledTalk.create
GET/api/v1/scheduled-talk/conversations/{conversationId}/history
Lists the past calls of a chat, paged.
meetings.scheduledTalk.getConversationHistory
GET/api/v1/scheduled-talk/upcoming
Lists the scheduled calls the caller is invited to or can join that have not started yet.
meetings.scheduledTalk.getUpcomingForMe
Request bodies:
CreateScheduledTalkDto(create): no field is required.
Example
meetings.meeting.getLive: lists the scheduled meetings the caller can see that are running now or about to start, with a join link.
curl
curl -s "https://volobox.example.com/api/v1/meeting/live" \
-H "Authorization: Bearer $VOLOBOX_TOKEN"