How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nylas Scheduling API

Scheduler. Booking configurations, scheduling sessions, availability lookups and booking lifecycle management for hosted and component-based booking flows.

Nylas Scheduling API is one of 13 APIs that Nylas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scheduling. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against 2 base URLs: https://api.us.nylas.com, https://api.eu.nylas.com.

12 operations 6 paths 27 schemas 3 DELETE3 GET1 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.us.nylas.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nylas Scheduling API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (NYLAS_ACCESS_TOKEN) (ACCESS_TOKEN). It accepts HTTP bearer tokens (NYLAS_API_KEY) (NYLAS_API_KEY). By default, every request must be authenticated.

  • ACCESS_TOKEN — The Nylas access token for a specific grant. Issued as part of OAuth 2.1 flow token exchange.
  • NYLAS_API_KEY — The Nylas API key provides application-level access to APIs and all grants. You can generate these from the Dashboard. Learn more about [authorizing requests](…

Paths & Operations 12

Across 6 paths, the API surfaces 12 operations — 3 DELETE, 3 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Scheduling 12
POST
/v3/grants/{grant_id}/scheduling/configurations
Create Configuration
post-configurations 1 param body → 200400401429504
GET
/v3/grants/{grant_id}/scheduling/configurations
Return all Configuration objects
get-configurations 3 params → 200400401429504
GET
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}
Return a Configuration
get-configurations-id 2 params → 200400401404429504
PUT
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}
Update Configuration
put-configurations-id 2 params body → 200400401404429504
DELETE
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}
Delete a Configuration
delete-configurations-id 2 params → 200400401404429504
POST
/v3/scheduling/bookings
Book an event
post-bookings 4 params body → 200400401404429504
GET
/v3/scheduling/bookings/{booking_id}
Return a booking
get-bookings-id 4 params → 200400401404429504
PATCH
/v3/scheduling/bookings/{booking_id}
Reschedule a booking
patch-bookings-id 4 params body → 200400401404429504
PUT
/v3/scheduling/bookings/{booking_id}
Confirm a booking
put-bookings-id 4 params body → 200400401404429504
DELETE
/v3/scheduling/bookings/{booking_id}
Delete a booking
delete-bookings-id 4 params body → 200400401404429504
POST
/v3/scheduling/sessions
Create a session
post-sessions body → 200400401429504
DELETE
/v3/scheduling/sessions/{session_id}
Delete a session
delete-session 1 param → 200400401429504

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are configuration_scheduler (14 properties), configuration_event_booking (10 properties), configuration_participants (9 properties), booking_create (8 properties). Each schema is shown below with its type and property counts.

configuration_scheduler_additional_fields
object
The definitions for additional fields to be displayed in the Scheduler UI. Guest will see the additional fields on the Scheduling Page when they book an event.
7 properties 3 required
event_conferencing_request
object
An object that lets you automatically create a conference, or enter conferencing details manually. You can't use autocreate and details in the same request. If…
configuration_participants_specific_time_availability
array
A specific date and time range when the participant is available. Use "00:00" for both start and end to explicitly mark a date as unavailable.
configuration_participants
object
List of participants for the scheduling Configuration.
9 properties 3 required
configuration_availability
object
The rules that determine the available time slots for the event.
4 properties 1 required
configuration_availability_rules
object
Availability rules for the scheduling configuration. These rules define how Nylas calculates availability for all participants.
5 properties
200-delete
Delete Succeeded
configuration_scheduler
object
14 properties
common_response_with_cursor
object
3 properties
common_response
object
2 properties
configuration_appearance
object
Appearance settings definitions for the Scheduling Page.
1 property
booking_update
object
2 properties 2 required
configuration_scheduler_email_template_booking_confirmed
object
Configurable settings specifically for booking confirmed emails.
2 properties
booking_confirm
object
3 properties 2 required
configuration_event_booking
object
10 properties 1 required
booking_update_group
object
5 properties 4 required
booking_create
object
8 properties 3 required
booking
object
6 properties 5 required
configuration_availability_open_hours
object
Open hours settings for a participant.
5 properties
meeting_settings_common
object
A collection of settings for the Notetaker bot.
8 properties
group-configuration
object
7 properties 3 required
meeting_settings
configuration_participants_availability
object
The availability data for the participant. If omitted, the participant is considered to be available at all times. At least one participant must have availabil…
2 properties 1 required
configuration
object
8 properties 3 required
configuration_scheduler_email_template
object
Configurable settings for booking emails.
3 properties
configuration_participants_booking
object
The booking data for the participant. If omitted, the participant is not included in the booked event. At least one participant must have booking data.
1 property 1 required
availability_buffer
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nylas-scheduling-api-openapi.yml Raw ↑

Other APIs Nylas publishes across the network.

Nylas Admin API
Nylas Auth API
Nylas Calendars API
Nylas Contacts API
Nylas Drafts API
Nylas Events API
Nylas Grants API
Nylas Messages API
Nylas Threads API
Nylas Notifications API
Nylas Notetaker API
Nylas Templates and Workflows API
Where this information came from

This is an independent, third-party profile of Nylas Scheduling API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.