Skip to content
/
Reference
Search the docs...
API Reference
API
API Reference
UI Reference
Docs
API Reference
REST API
Getting started
Overview
Authentication
Authentication APIs
4
Overview
Hosted OAuth - Authorization Request
GET
Hosted OAuth - Token exchange
POST
Hosted OAuth - Revoke OAuth token
POST
OAuth Token Info
GET
Manage Grants
6
Overview
Bring Your Own Authentication
POST
Return all grants
GET
Get a grant
GET
Update a grant
PATCH
Delete a grant
DELETE
Get current grant
GET
Email
Messages
9
Overview
Return all Messages
GET
Return a Message
GET
Update message attributes
PUT
Delete a message
DELETE
Clean messages
PUT
Send a Message
POST
Return scheduled messages
GET
Return a scheduled message
GET
Cancel a scheduled message
DELETE
Threads
4
Overview
Return all threads
GET
Return a thread
GET
Update a thread
PUT
Delete a thread
DELETE
Drafts
6
Overview
Return all Drafts
GET
Create a Draft
POST
Return a Draft
GET
Send a Draft
POST
Update a draft
PUT
Delete a Draft
DELETE
Folders
5
Overview
Return all folders
GET
Create a Folder
POST
Return a Folder
GET
Update a folder
PUT
Delete a Folder
DELETE
Smart compose
2
Overview
Compose a message
POST
Compose a reply
POST
Attachments
2
Overview
Return Attachment metadata
GET
Download an Attachment
GET
Transactional send
1
Overview
Send a transactional email
POST
Calendar
Calendar
7
Overview
Return all calendars
GET
Create a calendar
POST
Return a calendar
GET
Update a calendar
PUT
Delete a calendar
DELETE
Get availability
POST
Get free/busy schedule
POST
Events
7
Overview
Return all events
GET
Create an event
POST
Import events
GET
Return an event
GET
Update an event
PUT
Delete an event
DELETE
Send RSVP
POST
Room resources
1
Overview
Return room resource information
GET
Contacts
Contacts
6
Overview
Return all contacts
GET
Create contact
POST
Return a contact
GET
Update a contact
PUT
Delete a contact
DELETE
Return all Contact Groups
GET
Scheduling
Configurations
5
Overview
Return all Configuration objects
GET
Create Configuration
POST
Return a Configuration
GET
Update Configuration
PUT
Delete a Configuration
DELETE
Sessions
2
Overview
Create a session
POST
Delete a session
DELETE
Bookings
5
Overview
Book an event
POST
Return a booking
GET
Confirm a booking
PUT
Reschedule a booking
PATCH
Delete a booking
DELETE
Availability
1
Overview
Get availability
GET
Group Events
6
Overview
Get all group events
GET
Create group event
POST
Update a group event
PUT
Delete a group event
DELETE
Import group events
POST
Validate time slot
POST
Notetaker
Notetaker
9
Overview
Return all Notetakers
GET
Invite Notetaker to meeting
POST
Return a Notetaker
GET
Update scheduled Notetaker
PATCH
Delete a Notetaker
DELETE
Return Notetaker history
GET
Cancel scheduled Notetaker
DELETE
Remove Notetaker from meeting
POST
Return Notetaker media links
GET
Standalone Notetaker
9
Overview
Return all standalone Notetakers
GET
Invite standalone Notetaker to meeting
POST
Return a standalone Notetaker
GET
Update standalone Notetaker
PATCH
Delete a standalone Notetaker
DELETE
Return standalone Notetaker history
GET
Cancel standalone Notetaker
DELETE
Remove standalone Note...from meeting
POST
Return standalone Note...r media links
GET
Notifications
Webhook Notifications
8
Overview
Get destinations for an application
GET
Create a webhook destination
POST
Get the destinations f...by webhook ID
GET
Update a webhook destination
PUT
Delete a webhook destination
DELETE
Rotate a webhook secret
POST
Get mock notification payload
POST
Send test event
POST
Pub/Sub Notifications
5
Overview
Get Pub/Sub channels f...n application
GET
Create a Pub/Sub channel
POST
Get a specific Pub/Sub channel
GET
Update a Pub/Sub channel
PUT
Delete a specific Pub/Sub channel
DELETE
Templates & Workflows
Application-level templates
7
Overview
Return all templates
GET
Create a template
POST
Return a template
GET
Update a template
PUT
Delete a template
DELETE
Render template as HTML
POST
Render a template
POST
Grant-level templates
7
Overview
Return all templates
GET
Create a template
POST
Return a template
GET
Update a template
PUT
Delete a template
DELETE
Render a template
POST
Render template as HTML
POST
Application-level workflows
5
Overview
Return all workflows
GET
Create a workflow
POST
Return a workflow
GET
Update a workflow
PUT
Delete a workflow
DELETE
Grant-level workflows
5
Overview
Return all workflows
GET
Create a workflow
POST
Get a workflow
GET
Update a workflow
PUT
Delete a workflow
DELETE
Administration
Applications
7
Overview
Get application
GET
Update an application
PATCH
Get an application's callback URIs
GET
Add callback URI to application
POST
Return a callback URI
GET
Update a callback URI
PATCH
Delete a callback URI
DELETE
Connectors (Integrations)
6
Overview
List connectors
GET
Create a connector
POST
Get connector
GET
Update a connector
PATCH
Delete a connector
DELETE
Detect provider
POST
Connector credentials
5
Overview
List credentials
GET
Create a credential
POST
Get credential
GET
Update a connector credential
PATCH
Delete credential
DELETE
Manage API keys
4
Overview
Get all API keys
GET
Create API key
POST
Get API key
GET
Delete API key
DELETE
Manage Domains
7
Overview
List domains
GET
Create domain
POST
Get domain
GET
Update domain
PUT
Delete domain
DELETE
Get domain info
POST
Verify domain
POST
Workspaces
7
Overview
Return all workspaces
GET
Create a workspace
POST
Return a workspace
GET
Update a workspace
PATCH
Delete a workspace
DELETE
Automatically group gr...nto workspace
POST
Update workplace assignments
POST
Other
ExtractAI
3
Overview
Get all e-commerce orders
GET
Get all e-commerce shipments
GET
Get all e-commerce returns
GET
App migration
5
Overview
Link a v2 app to a v3 app
POST
Import v2 app settings...linked v3 app
POST
Migrate v2 account to v3 grant
POST
Batch clone v2 accounts to v3 grants
POST
Get migration jobs
GET
Data migration
1
Overview
Translate v2 Nylas ID...3 Provider ID
POST