NYnylas
Calendar

Get free/busy schedule

Changed on

(Not supported for iCloud) Returns the free/busy schedule for the specified list of email addresses.

Keep in mind

  • The grant ID included in the request must have access to view the provided email addresses' free/busy data. This is usually configured by the provider.
  • All specified email addresses must use the same provider.
  • This endpoint always returns 200 OK, even if one of the responses returns an error. Be sure to check for any errors in the list of responses.
  • Microsoft's availability calculation is limited to a maximum of 1,000 entries per time slot for each email address included in the request.
  • The free/busy response does not include all-day room resource bookings on Google or Microsoft.
  • You can include up to 20 email addresses for Microsoft Graph, and up to 50 email addresses for Google in a single request.
post/v3/grants/{grant_id}/calendars/free-busy

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

start_timeinteger required

The start of a time block, in seconds using the Unix timestamp format. Nylas uses start_time and end_time to assess the specified account's free/busy schedule.

end_timeinteger required

The end of a time block, in seconds using the Unix timestamp format. Nylas uses start_time and end_time to assess the specified account's free/busy schedule.

For Google and EWS accounts, Nylas can query a timespan of up to 3 months from the start_time.

For Microsoft Graph accounts, Nylas can query a timespan of up to 62 days from the start_time.

emailsstring[] required

A list of email addresses to check the free/busy schedules for.

tentative_as_busyboolean

When true, Nylas treats tentative events as busy.

Example request

{
  "start_time": 1690862400,
  "end_time": 1691208000
}

Response

Free/Busy Response

request_idstring

The request ID.

Changes