Skip to content
Docs
or

Nylas Postman collection

You can use the Nylas Postman workspace to quickly start using the Nylas APIs. The workspace includes three collections, one for each area of the Nylas API, along with a shared set of environment variables.

Collections

Section titled “Collections”

Nylas Administration API

Section titled “Nylas Administration API”

Manage your Nylas applications, connectors, grants, and webhooks.

Run In Postman

Nylas Email, Calendar, Contacts, and Notetaker APIs

Section titled “Nylas Email, Calendar, Contacts, and Notetaker APIs”

Work with email, calendars, events, contacts, and notetaker bots.

Run In Postman

Nylas Scheduler APIs

Section titled “Nylas Scheduler APIs”

Create and manage scheduling configurations, sessions, bookings, and availability.

Run In Postman

Set up Postman

Section titled “Set up Postman”
  1. Navigate to the Nylas Postman workspace to access the collections online.
  2. Fork the collection you want to use. This creates a copy in your own workspace that you can modify. The Postman UI displaying a drop-down menu. The 'Create a Fork' option is highlighted.
  3. Select the v3 Environment to load the shared environment variables.

Environment variables

Section titled “Environment variables”

All three collections share a single set of environment variables. To see them, click the Environment symbol and select v3 Environment.

The following environment variables are required to start using the Nylas APIs:

  • baseUrl: The Nylas API URL. This is provided by default.
    • The baseUrl must include the region in which your Nylas application is located. By default, the collection uses the U.S. API URL (https://api.us.nylas.com). For more information, see the Data residency documentation.
  • bearerToken: Your Nylas API key, available from the Nylas Dashboard.
  • grant_id: A grant ID representing a user’s Nylas account.

Some environment variables are filled in by default, and others are not:

  • Autogenerated: These values are replaced as you start making requests. You can remove the autogenerated setting and replace them manually.
  • URL: This value is pre-filled with the U.S. Nylas API URL (https://api.us.nylas.com).
  • Blank fields: You must provide these values.

To modify your environment variables, click the eye symbol at the top-right of the page and edit the current value for the parameters you want to update. Nylas recommends that you modify current values only, as current values overwrite the initial values when you make API calls.

Make an API call

Section titled “Make an API call”

Now that you’re all set up, you can make your first API call! Try making a Get Grant request to retrieve a user’s grant information.

What’s next?

Section titled “What’s next?”