How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Google Workspace (G Suite)

Google Workspace (G Suite) Gmail API

The Gmail API from Google Workspace (G Suite) — 10 operation(s) for gmail.

Documentation Provider Profile APIs.io OpenAPI GitHub

Google Workspace (G Suite) Gmail API is one of 3 APIs that Google Workspace (G Suite) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gmail. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, pricing, and a getting-started guide.

This API exposes 11 operations across 10 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://gmail.googleapis.com.

11 operations 10 paths 3 schemas 5 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://gmail.googleapis.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Google Workspace (G Suite) Gmail API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 5 scopes. By default, every request must be authenticated.

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 5 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Gmail 11
GET
/gmail/v1/users/{userId}/profile
Get user profile
getProfile 1 param → 200
POST
/gmail/v1/users/{userId}/watch
Watch for changes
watch 1 param body → 200
POST
/gmail/v1/users/{userId}/stop
Stop push notifications
stop 1 param → 200
GET
/gmail/v1/users/{userId}/drafts
List drafts
listDrafts 5 params → 200
POST
/gmail/v1/users/{userId}/drafts
Create draft
createDraft 1 param body → 200
POST
/gmail/v1/users/{userId}/drafts/send
Send draft
sendDraft 1 param body → 200
GET
/gmail/v1/users/{userId}/messages
List messages
listMessages 6 params → 200
POST
/gmail/v1/users/{userId}/messages/send
Send message
sendMessage 1 param body → 200
GET
/gmail/v1/users/{userId}/labels
List labels
listLabels 1 param → 200
GET
/gmail/v1/users/{userId}/threads
List threads
listThreads 5 params → 200
PUT
/gmail/v1/users/{userId}/settings/vacation
Update vacation settings
updateVacationSettings 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Label (10 properties), Message (9 properties), Draft (2 properties). Each schema is shown below with its type and property counts.

Label
object
10 properties
Message
object
9 properties
Draft
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-suite-gmail-api-openapi.yml Raw ↑

Other APIs Google Workspace (G Suite) publishes across the network.

Google Meet API
AE Profile APIs.io
Google Forms API
AE Profile APIs.io
#Gmail
← Back to G APIs
API Details
ID
google-suite:google-suite-gmail-api
Base URL
https://gmail.googleapis.com
Docs
https://developers.google.com/gmail/api
Provider
Google Workspace (G Suite)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=google-suite-gmail-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/google-suite-gmail-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Google Workspace (G Suite) Gmail API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.