Gmail

Integrate your application with the Gmail API

🚀 Quickstart

Connect to Gmail with Nango and see data flow in 2 minutes.

1. Create the integration

   In Nango (free signup), go to Integrations -> Configure New Integration -> Gmail.

   Nango has credentials you can use for testing. Activate them in the dashboard.

2. Authorize Gmail

   Go to Connections -> Add Test Connection -> Authorize, then log in to Gmail. Later, you’ll let your users do the same directly from your app.

3. Call the Gmail API

   Let’s make your first request to the Gmail API (fetch the profile of the currently signed-in user). This request will return basic details about the authenticated user, such as their email address and message/thread counts. Replace the placeholders below with your secret key, integration ID, and connection ID:

   cURL

   curl "https://api.nango.dev/proxy/gmail/v1/users/me/profile" \
     -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
     -H "Provider-Config-Key: <INTEGRATION-ID>" \
     -H "Connection-Id: <CONNECTION-ID>"
   

   Node

   Install Nango’s backend SDK with npm i @nangohq/node. Then run:

   import { Nango } from '@nangohq/node';
   
   const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
   
   const res = await nango.get({
       endpoint: '/gmail/v1/users/me/profile',
       providerConfigKey: '<INTEGRATION-ID>',
       connectionId: '<CONNECTION-ID>'
   });
   
   console.log(res.data);
   

   Or fetch credentials dynamically via the Node SDK or API.

   ✅ You’re connected! Check the Logs tab in Nango to inspect requests.

4. Implement Nango in your app

   Follow our Auth implementation guide to integrate Nango in your app.

   To obtain your own production credentials, follow the setup guide linked below.

📚 Gmail Integration Guides

Nango maintained guides for common use cases.

• How to register your own Gmail OAuth app
  Register an OAuth app with Gmail and obtain credentials to connect it to Nango

• How to setup webhooks with Gmail on Nango Set up Gmail push notifications using Google Pub/Sub to receive real-time inbox updates

• Google App & Security Review Pass Google’s OAuth app verification and CASA security assessment to go to production

Official docs: Gmail API docs

🧩 Pre-built syncs & actions for Gmail

Enable them in your dashboard. Extend and customize to fit your needs.

Others

Function name	Description	Type	Source code
filters	Sync Gmail mailbox filters and their criteria or actions.	Sync	🔗 Github
labels	Sync built-in and user-created Gmail labels.	Sync	🔗 Github
messages	Sync Gmail messages with an initial backfill followed by history-based incremental updates.	Sync	🔗 Github
send-as-aliases	Sync configured Gmail send-as aliases and alias settings	Sync	🔗 Github
threads	Sync Gmail conversation threads with full message hydration	Sync	🔗 Github

---