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