Get Available Meeting Times
Salesforce Inbox must be enabled in your org.
This object is available in API version 66.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/getAvailableMeetingTimes
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token
Inputs
| Input | Type | Description |
|---|---|---|
| attendeeEmailAddresses | string (collection) | Required. A list of the meeting attendees' email addresses, excluding the meeting owner. Maximum 100 addresses. |
| endDate | string | The end date in ISO date-time format for when to stop looking for available meeting time slots. |
| limitPerDay | string | The maximum number of meeting time slots to find for a given date. Default value is 1. |
| meetingDescription | string | A description of the scheduled meeting. |
| meetingName | string | The name of the scheduled meeting. Default value is "Meeting with attendee". |
| meetingOwnerId | string | The ID of the Salesforce Inbox user who owns the meeting. If no owner is specified, the ID of the current user is used. |
| metadataOrchestrationId | string | The ID of this action's orchestration. The ID can be an Action Cadence Step Tracker or other orchestration. The ID associates the meeting with the Action Cadence Step Tracker used by the agent to engage with the target. |
| metadataTargetId | string | The target record ID associated with a lead, contact, or person account. This ID typically belongs to the attendee and is used to connect the meeting with the Action Cadence Step Tracker used by the agent to engage with the target. |
| numberOfTimeSlots | string | The maximum number of meeting time slots to look for. Default value is 3. |
| startDate | string | The start date in ISO date-time format for when to begin looking for available meeting time slots. |
| timeZone | string | The TimeZoneSidKey used to look up available meeting time slots. When not specified, the value is the same TimeZoneSidKey as the Meeting Owner. |
Outputs
| Output | Type | Description |
|---|---|---|
| epochTimes | string | The epoch time values in milliseconds corresponding to the available time slots. |
| meetingRequestId | string | The ID of the meeting request associated with the group of generated time slots. Use this ID with the Confirm Sales Meeting action to book a time slot. |
| outputErrorCode | string | The error code returned by the Get Available Meeting Times action. |
| outputErrorMessage | string | The error message returned by the Get Available Meeting Times action. |
| timeSlots | string | The list of available time slots for booking a meeting from the Salesforce Inbox user's calendar. |
Usage
Sample Input
1{
2 "inputs": [
3 {
4 "attendeeEmailAddresses": ["prospect@example.com", "stakeholder@example.com"],
5 "startDate": "2026-07-10T00:00:00Z",
6 "endDate": "2026-07-17T00:00:00Z",
7 "numberOfTimeSlots": "3",
8 "limitPerDay": "1",
9 "meetingName": "Product Demo",
10 "meetingDescription": "Demo of our latest features",
11 "timeZone": "America/New_York"
12 }
13 ]
14}Sample Output
1{
2 "outputs": [
3 {
4 "timeSlots": "Mon, Jul 14 2:00 PM - 3:00 PM EDT; Tue, Jul 15 10:00 AM - 11:00 AM EDT; Wed, Jul 16 3:00 PM - 4:00 PM EDT",
5 "epochTimes": "1752566400000,1752638400000,1752728400000",
6 "meetingRequestId": "0MRXX00000001ABCDE"
7 }
8 ]
9}This invocable action queries the user's calendar and returns available meeting times based on the specified criteria. After retrieving available time slots, the Confirm Sales Meeting invocable action can be used to book the selected time slot.
For more information about this invocable action, see Sales | Return Calendar Link and Sales | Send Meeting Request in the Agentforce Standard Action Reference and Flow Core Actions: Generate Sales Meeting Link Action in Salesforce Help.