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 Calendars API

Calendars. List and manage a grant's calendars, query free/busy availability across participants, and read room and resource calendars.

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

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

This API exposes 9 operations across 6 paths, and defines 34 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.

9 operations 6 paths 34 schemas 1 DELETE4 GET3 POST1 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 Calendars 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 9

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

Calendars 9
GET
/v3/grants/{grant_id}/calendars
Return all calendars
get-all-calendars 5 params → 200400401429504
POST
/v3/grants/{grant_id}/calendars
Create a calendar
create-calendar 2 params body → 200400401429504
GET
/v3/grants/{grant_id}/calendars/{calendar_id}
Return a calendar
get-calendars-id 3 params → 200400401404429504
PUT
/v3/grants/{grant_id}/calendars/{calendar_id}
Update a calendar
put-calendars-id 3 params body → 200400401404429504
DELETE
/v3/grants/{grant_id}/calendars/{calendar_id}
Delete a calendar
delete-calendars-id 2 params → 200400401404429504
POST
/v3/calendars/availability
Get availability
post-availability body → 200400401429504
POST
/v3/grants/{grant_id}/calendars/free-busy
Get free/busy schedule
post-calendars-free-busy 1 param body → 200400401429504
GET
/v3/scheduling/availability
Get availability
get-availability 6 params → 200400401404429504
GET
/v3/grants/{grant_id}/resources
Return room resource information
list-room-resources 3 params → 200400401429504

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are calendar_common (14 properties), resource (8 properties), meeting_settings_common (8 properties), availability_time_slot (6 properties). Each schema is shown below with its type and property counts.

calendar
calendar_owner_email
string
(Microsoft only) The email address of the account that owns the calendar. Use it to tell the grant's own calendars apart from calendars shared with the grant.…
object
string
The type of object.
calendar_name
string
The name of the calendar.
freebusy_request
object
4 properties 3 required
resource_floor_name
string
The name of the floor where the room is located.
availability_time_slot
object
6 properties
resource
object
8 properties
calendar_location
string
(Not supported for iCloud or EWS) The geographic location of the calendar, as free-form text.
grant_id
string
The ID of grant for the connected user.
common_response_with_cursor
object
3 properties
calendar_read_only
boolean
Set by the provider. If true, indicates that the calendar is read-only. If the calendar is read-only, all of its events have readonly set to true. This field c…
common_response
object
2 properties
resource_email
string
The email address associated with the room resource.
calendar_description
string
(Not supported for iCloud or EWS) A brief description of the calendar.
metadata
object
The metadata associated with the object. For more information, see [Metadata](/docs/reference/api/metadata).
calendar_common
object
A Calendar object.
14 properties
id
string
A globally unique object identifier for Microsoft accounts. An email address for Google accounts.
availability_specific_time_availability
object
A specific date and time range when the participant is available.
4 properties 4 required
availability_rules
object
5 properties
resource_capacity
integer
The number of people the room can seat.
meeting_settings
resource_floor_number
integer
The floor number where the room is located.
calendar_hex_color
string
(Not supported for iCloud or EWS) The background color of the calendar, in hexadecimal format (for example, 0099EE). When empty, Nylas uses the default backgro…
calendar_timezone
string
(Google and virtual calendars only) An [IANA timezone database](https://en.wikipedia.org/wiki/Tzdatabase) formatted string (for example, America/NewYork).
resource_floor_section
string
The section of the floor where the room is located.
availability_response
object
The response to a successful request to get availability for a participant.
2 properties
is_owned_by_user
boolean
If true, indicates that the user owns the calendar. This field can't be modified once set.
resource_building
string
The name of the building where the room is located.
availability_open_hours
object
A time block when a participant is available for meetings.
5 properties
meeting_settings_common
object
A collection of settings for the Notetaker bot.
8 properties
calendar_hex_foreground_color
string
(Google only) The foreground color of the calendar, in hexadecimal format (for example, 0099EE). When empty, Nylas uses the default foreground color. You can m…
calendar_sync
object
3 properties
availability_buffer
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nylas-calendars-api-openapi.yml Raw ↑

Other APIs Nylas publishes across the network.

Nylas Admin API
Nylas Auth API
Nylas Contacts API
Nylas Drafts API
Nylas Events API
Nylas Grants API
Nylas Messages API
Nylas Scheduling 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 Calendars 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.