Group Booking API
The Group Booking API automates meeting scheduling for groups by gathering availability from multiple calendars and finding suitable time slots.
The Group Booking API is a powerful tool designed to facilitate the automated scheduling of meetings within a group. It enables developers to gather availability information from multiple user calendars and find time slots when at least one user is available.
The API is built on top of the Aurinko User concept. Please see User OAuth Flow section to understand how to add a user and one or more accounts/calendars.
Booking profile
At the heart of the Group Booking API lies a booking/availability profile for a set of accounts or groups of accounts. This profile consists of a set of properties that describe calendar availability and the types of meetings that can be booked. It includes the following information:
Work hours
Meeting duration
Meeting subject
Meeting description
Meeting teleconference link
Meeting location
Profile scheduler link
Profile active period
And more...
To create a new booking profile POST json payload to the /book/group/profiles endpoint:
curl -u ClientId:Secret \
-X POST https://api.aurinko.io/v1/book/group/profiles \
-d '{
"id": 1,
"name": "aurinkoDemo",
"durationMinutes": 30,
"availabilityStep": 15,
"timeAvailableFor": "30D",
"subject": "Aurinko Demo",
"description": "A conference call with Aurinko.",
"location": "Teleconference",
"workHours": {
"timezone": "Americas/New\_York",
"daySchedules": [
{
"dayOfWeek": "monday",
"workingIntervals": [{"start": "14:15:22Z","end": "14:15:22Z"},...]
},
...
],
},
"context": "string",
"startConference": true
}' You can insert variables like {{name}}, {{comments}} in the meeting description text. They will be passed to a scheduling widget to be filled by an end user booking a meeting (see additionalFields of the availability endpoint below).
Use PATCH request to update existing profiles:
curl -u ClientId:Secret \
-X PATCH https://api.aurinko.io/v1/book/group/profiles/{id} \
-d '{
"name": "aurinkoDemo",
"durationMinutes": 30,
"availabilityStep": 15,
"timeAvailableFor": "30D",
"subject": "Aurinko Demo",
"description": "My new event description",
"location": "Google Hangout",
"context": "string",
"startConference": true
}'To associate accounts with a booking profile, use the attachAccounts endpoint:
curl -u ClientId:Secret \
-X POST https://api.aurinko.io/v1/book/group/profiles/{id}/attachAccounts \
-d '{ "accountIds": [accId1, accId2]
}'To associate groups of accounts with a booking profile, use the attachGroups endpoint:
curl -u ClientId:Secret \
-X POST https://api.aurinko.io/v1/book/group/profiles/{id}/attachGroups \
-d '{ "groups": [
{ "extId": "groupExtId1",
"accountIds": [accId1, accId2],
"required": "one"
},
{ "extId": "groupExtId2",
"accountIds": [accId3, accId4],
"required": "all"
}
]
}'The required field in the request body determines how the booking should handle group availability:
"one"– The meeting can be scheduled if at least one member of the group is available."all"– The meeting can be scheduled only if all members of the group are available.
Availability
Once a booking profile is created, and its accounts/groups are defined the availability endpoint can be used to query the members availability for the types of meetings defined in the profile and within the specified work hours.
curl -X GET
https://api.aurinko.io/v1/book/group/profiles/{id}/meeting?required=one|all
This endpoint produces information that can be used to build a public calendar page like Aurinko's Calendar Page.
groupXids indicate which groups are available for a given time slot.
accountIds indicate which accounts are available for a given time slot.
{
"items": [
{
"start": "2024-01-27T14:00:00Z",
"end": "2024-01-27T14:45:00Z",
"groupXids": ["group1", "group2", "group3"],
"accountIds": [id1, id2, id3, ...]
},
...
],
"startTime": "2024-01-01T00:00:00Z",
"endTime": "2024-04-01T00:00:00Z",
"durationMinutes": 45,
"availabilityStep": 15,
"subject": "Aurinko Demo",
"primaryColor":"#303030",
"secondaryColor":"#30A9EE",
"additionalFields": [
{
"name":"comment",
"type":"text",
"default": null
},
...
]
}The additionalFields array contains the {{variables}} that you specified in the meeting description text. If you're building your own scheduling widget it needs to ask the end user for those inputs. Booking a meeting will require the fields that don't specify defaults.
Schedule
Book a meeting by sending json payload to the book/group/profiles/{id}/meeting?required=one|all endpoint and specify groupXids and/or accountIds that you received earlier for the specified time slot:
curl -X POST {id}/meeting \
-d '{
"time": {
"start": "2024-01-27T14:00:00Z",
"end": "2024-01-27T14:45:00Z"
},
"groupXids": ["group1", "group2", "group3"],
"accountIds": [id1, id2, id3, ...],
"name": "string",
"email": "string",
"substitutionData": {
"property1": "string",
"property2": "string"
}
}' Specify the accountIds or groupXids that you received from the availability endpoint.
A new event will be created based on the profile:
If an account is specified, the event will be scheduled in its primary calendar.
If a group is specified, the event will be scheduled in the primary calendar of an available account within that group.
In both cases, the person specified in the email and name fields will be invited to the event. In the '?required=all' mode also all specified accounts will be invited.
Last updated