Get availability - Calendar - API Reference

POST

/v3/calendars/availability

Returns availability information for the specified user or group of users. All participants' email addresses must be associated with valid Nylas grants, and should be unique within their application.

NYLAS API KEYACCESS TOKEN

Request body

availability_rulesobject

duration_minutes*integer

The duration of each time slot, in minutes. The duration must be a multiple of 5 minutes.

Example: 30

end_time*integer

The end of the time slot that Nylas checks availability for, in seconds using the Unix timestamp format. The time must be a multiple of 5 minutes.

Example: 1659733200

interval_minutesinteger

Nylas generates a time slot every interval_minutes (for example, every 30 minutes) and returns only slots when all participants are free. The interval must be a multiple of 5 minutes.

Example: 30

participants*array<object>

A list of participants to get availability information for.

round_tointeger

Nylas rounds each time slot to the nearest round_to value. For example, if a time slot starts at 9:05a.m. and round_to is set to 15, Nylas rounds it to 9:15a.m. The round to value must be a multiple of 5 minutes.

Default: 15

Example: 15

start_time*integer

The beginning of the time slot that Nylas checks availability for, in seconds using the Unix timestamp format. The time must be a multiple of 5 minutes.

Example: 1659366000

Responses

request_idstring

The request ID.

dataobject

The response to a successful request to get availability for a participant.

curl --compressed --request POST \ --url 'https://api.us.nylas.com/v3/calendars/availability' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "participants": [ { "email": "[email protected]", "calendar_ids": ["[email protected]"], "open_hours": [{ "days": [0,1,2], "timezone": "America/Toronto", "start": "9:00", "end": "17:00", "exdates": [] }] }, { "email": "[email protected]", } ], "start_time": 1600890600, "end_time": 1600999200, "interval_minutes": 30, "duration_minutes": 30, "round_to": 15, "availability_rules": { "availability_method": "collective", "buffer": { "before": 15, "after": 15 }, "default_open_hours": [ { "days": [0,1,2], "timezone": "America/Toronto", "start": "9:00", "end": "17:00", "exdates": [] }, { "days": [3,4,5], "timezone": "America/Toronto", "start": "10:00", "end": "18:00", "exdates": [] } ] } }'