Get Availability
GET {{baseUrl}}/v3/scheduling/availability?start_time=1722291193&end_time=1724969593&configuration_id={{configuration_id}}&booking_id={{booking_id}}
Gets available time slots within the specified time range, using the rules defined in the Configuration object.
Nylas validates the provided session ID and uses it to retrieve the related Configuration object. If you created a public configuration, you don't need to include the Authorization
request header with a session ID, but you must pass the Configuration object ID as a query parameter.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
start_time | number | (Required) A Unix timestamp for the start time to check availability for. | |
end_time | number | (Required) A Unix timestamp for the end time to check availability for. | |
configuration_id | string | The ID of the Configuration object whose settings are used for calculating availability. Required only if you're not using session authentication (requires_session_auth is set to false ). | |
booking_id | string | This is the ID of the booking to reschedule, if you are checking availability to reschedule a round-robin booking. Required only if availability_method is max-fairness or max-availability . See Retrieving booking IDs for more information. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"request_id":"\u003cstring\u003e","data":"\u003cobject\u003e"}