GetUserAvailability
Provides free/busy availability data for a list of users, rooms, and resources over a defined time range. It is often used for scheduling meetings by determining when participants are available.
Input
| Name | Type | Required | Description |
| Mailboxes | String | True | An XML-formatted list of one or more email addresses representing the users whose calendar availability should be retrieved. This input is required and supports multiple entries. |
| StartTime | String | True | The starting date and time of the period for which availability information is requested. This input is required and should be in a recognized datetime format. |
| EndTime | String | True | The ending date and time of the period for which availability information is requested. This input is required and defines the end of the range to evaluate. |
| Timezone | String | False | The time zone to apply when interpreting StartTime and EndTime. Should be specified using a recognized time zone ID (for example, 'Eastern Standard Time'). Required for accurate availability alignment across time zones. |
Result Set Columns
| Name | Type | Description |
| Id | String | The unique identifier of the calendar event returned for the specified user. Useful for referencing or correlating calendar entries. |
| Subject | String | The subject or title of the calendar event. This is the text typically entered by the organizer to describe the meeting or appointment. |
| Location | String | The physical or virtual location associated with the calendar event (for example, a meeting room, Teams link, or conference call number). |
| StartTime | Time | The starting date and time of the calendar event, adjusted to the time zone specified in the request. |
| EndTime | Time | The ending date and time of the calendar event, adjusted to the time zone specified in the request. |
| BusyType | String | The availability status of the user during the calendar event. Possible values include Free, Tentative, Busy, OOF (Out of Office), or Working Elsewhere. |
| IsMeeting | Boolean | A Boolean value indicating whether the event is a meeting (true) or a personal appointment (false). |
| IsRecurring | Boolean | A Boolean value indicating whether the event is part of a recurring series (true) or a standalone entry (false). |
| IsException | Boolean | A Boolean value indicating whether the event is an exception to a recurring series, such as a skipped or altered instance. |
| IsReminderSet | Boolean | A Boolean value indicating whether a reminder is configured for the event (true) or not (false). |
| IsPrivate | Boolean | A Boolean value indicating whether the event is marked as private, which limits the visibility of its content to the owner. |
| EmailAddress | String | The email address of the user to whom the returned calendar event belongs. This allows matching events to individual request targets. |