Get
Fetch a single record by ID.
- Source
- Others
- Alpha
- 8 entities
- Read & write
Move Gmail data anywhere it matters.
Load Gmail profile, drafts and labels into the warehouse or AI app you already run.
Source
Gmail
Snowflake
BigQuery
Postgres
Databricks
Claude
- Streams
- 8
- Entities
- 8
- Actions
- 7
- Destinations
- 50+
- Standard support
- 0.1.23
Overview
What is the Airbyte Gmail connector?
The Airbyte Gmail connector extracts data from Gmail and loads it into 50+ destinations such as Snowflake, BigQuery, Databricks or Postgres, with scheduled sync. It publishes 8 streams you can select per connection.
- 01
Sync to your warehouse
Land 8 Gmail tables in 50+ destinations on a schedule you control.
- 02
Live entity actions
Read, create, update and delete Gmail records at runtime through typed entity actions.
- 03
Context store search
Query synced Gmail data with filters, sorting and semantic search, without spending Gmail API rate limits.
- 04
One authorization
Authenticate Gmail once. The same connection powers scheduled syncs and runtime actions.
8 streams
Every table you can sync from Gmail
profile Primary key _(none)_ Sync modes FullIncr. drafts Primary key id Sync modes FullIncr. labels Primary key id Sync modes FullIncr. labels_details Primary key id Sync modes FullIncr. messages Primary key id Sync modes FullIncr. messages_details Primary key id Sync modes FullIncr.
Setup
Live in seven steps
Log into your Airbyte instance, click Sources, and click + New source.
Select Gmail from the source type dropdown.
Choose your authentication method: - Authenticate via Google (OAuth) — Click Authenticate your account and complete the Google sign-in flow. Airbyte Cloud users authenticate against Airbyte's pre-registered OAuth app. Airbyte Open Source users provide their own Client ID, Client Secret, and Refresh Token. - Service Account Key Authentication — Not currently usable. The connector authenticates as the service account itself, which has no mailbox. Use OAuth instead.
(Optional) Set Start date in YYYY-MM-DDTHH:MM:SSZ format. Only messages, drafts, and threads received on or after this date are replicated. If you leave it blank, the connector replicates the full mailbox history.
(Optional) Toggle Include Spam & Trash to include drafts and messages from the Spam and Trash folders. Defaults to off.
(Optional) Adjust Number of concurrent workers (between 2 and 10, default 5) to control how many requests the connector issues in parallel. Lower this value if you see frequent rate-limit errors.
Click Set up source to test the connection and save the configuration. The connection test reads the authenticated user's Gmail profile.
Configuration fields
| Field | Type | Description |
|---|---|---|
| credentials* | object | Credentials for connecting to the Gmail API |
| include_spam_and_trash | boolean | Include drafts/messages from SPAM and TRASH in the results. Defaults to false. |
| num_workers | integer | Number of concurrent workers used when syncing. Higher values result in faster syncs but may trigger rate limiting on lower-tier Gmail API quotas. The default works well for most accounts; if you see frequent rate-limit errors in sync logs, reduce this value. |
| start_date | string | UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ. Only messages, threads, and drafts received on or after this date will be replicated. If not set, all historical data will be replicated. |
7 actions
Supported Gmail actions
Context Store Search
Query synced data with filters and sorting, with no API rate limits.
List
Readlive records straight from the Gmail API.Create
Writea new record back into Gmail.Update
Patchfields on an existing record.Semantic Search
Natural-language search across synced Gmail records.
Delete
Removea record.
Full parameter-level details live in the Gmail entity reference.
Hybrid deployment
Sovereign by architecture, not by policy.
The data plane runs in your environment. Records, credentials and keys stay with you; the control plane only receives configuration and job metadata.
- Cloud
- OSS
- Hybrid
Your environment
Airbyte control plane
Use cases
What teams build with Gmail
List my recent emails
Show me unread messages in my inbox
Get the details of a specific email
List all my Gmail labels
Show me details for a specific label
List my email drafts
Get the content of a specific draft
List my email threads
Show me the full thread for a conversation
Get my Gmail profile information
Send an email to someone
Create a new email draft
Archive a message by removing the INBOX label
Mark a message as read
Mark a message as unread
Move a message to trash
Create a new label
Update a label name or settings
Delete a label
Search for messages matching a query
Find emails from a specific sender
Show me emails with attachments
Show me my latest emails
Find recent unread emails about topic
Show the conversation with person about topic
Related connectors
FAQ
Gmail connector questions
Do I need more than one Gmail connection?
No. One Gmail authorization powers both the scheduled syncs that land data in your destination and the entity actions your agents call at runtime.
Do Gmail entity actions need a sync to run first?
No. Entity actions read and write through the Gmail API as they are called, so they work immediately. Context store search is the exception: it queries data Airbyte has already synced, which is what lets it filter and sort without spending API rate limits.
What data can I sync from Gmail with Airbyte?
8 streams: profile, drafts, labels, labels details, messages, messages details, threads, threads details.
Does the Gmail connector support incremental sync?
Check the stream list on this page for the sync modes each Gmail table supports.
Where can I run the Gmail connector?
Run the Gmail connector on Cloud, OSS, Hybrid. Hybrid deployments keep the data plane in your environment while the control plane orchestrates syncs.
Didn't find your answer? Talk to sales
Start syncing Gmail in minutes.
Free 14-day trial. One connection powers your scheduled syncs and your live Gmail actions.