Business — entry 005 of 19
Gmail
The Gmail API gives OAuth-scoped programmatic access to a user's mailbox: reading, searching, sending, and organizing messages, threads, labels, and drafts, with message bodies transported as base64url-encoded MIME inside JSON. It requires a Google OAuth 2.0 bearer token, confirmed live via a `WWW-Authenticate: Bearer realm="https://accounts.google.com/"` challenge on an unauthenticated request, and unlike most server-side email APIs it explicitly supports cross-origin browser calls, echoing the request Origin on both a GET and an OPTIONS preflight.
AuthenticationOAuthRequires an OAuth flow; expect app registration.
HTTPSSupportedTraffic is encrypted in transit.
CORSEnabledCallable directly from browser JavaScript.
PricingFreeNo paid tier — free for the documented use case.
FormatsJSONResponses can be requested as JSON.
GreatAPIs Score
Score77
Authentication8/25OAuth flow required
Pricing20/20Free to use
Docs20/20Machine-readable spec file bundled
Formats9/15Single response format
Freshness20/20Verified within 6 months
Embed this badge
<a href="https://greatapis.com/api/gmail/"><img src="https://greatapis.com/badge/gmail.svg" alt="Scored 77 on greatapis.com"></a>Auth quickstart
- Register an app / run the OAuth flow to obtain a bearer token.
- Send it as an Authorization header
Authorization: Bearer <token>
Stored keyNo key stored
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
users79
GET/gmail/v1/users/{userId}/drafts
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
includeSpamTrash | query | no | boolean |
maxResults | query | no | integer |
pageToken | query | no | string |
q | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListDraftsResponse |
POST/gmail/v1/users/{userId}/drafts
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
message/cpim — Draft
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Draft |
POST/gmail/v1/users/{userId}/drafts/send
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
message/cpim — Draft
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
GET/gmail/v1/users/{userId}/drafts/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
format | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Draft |
PUT/gmail/v1/users/{userId}/drafts/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Request body
message/cpim — Draft
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Draft |
DELETE/gmail/v1/users/{userId}/drafts/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/history
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
historyTypes | query | no | array |
labelId | query | no | string |
maxResults | query | no | integer |
pageToken | query | no | string |
startHistoryId | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListHistoryResponse |
GET/gmail/v1/users/{userId}/labels
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListLabelsResponse |
POST/gmail/v1/users/{userId}/labels
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — Label
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Label |
GET/gmail/v1/users/{userId}/labels/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Label |
PUT/gmail/v1/users/{userId}/labels/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Request body
application/json — Label
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Label |
PATCH/gmail/v1/users/{userId}/labels/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Request body
application/json — Label
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Label |
DELETE/gmail/v1/users/{userId}/labels/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/messages
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
includeSpamTrash | query | no | boolean |
labelIds | query | no | array |
maxResults | query | no | integer |
pageToken | query | no | string |
q | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListMessagesResponse |
POST/gmail/v1/users/{userId}/messages
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
deleted | query | no | boolean |
internalDateSource | query | no | string |
Request body
message/cpim — Message
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
POST/gmail/v1/users/{userId}/messages/batchDelete
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — BatchDeleteMessagesRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
POST/gmail/v1/users/{userId}/messages/batchModify
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — BatchModifyMessagesRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
POST/gmail/v1/users/{userId}/messages/import
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
deleted | query | no | boolean |
internalDateSource | query | no | string |
neverMarkSpam | query | no | boolean |
processForCalendar | query | no | boolean |
Request body
message/cpim — Message
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
POST/gmail/v1/users/{userId}/messages/send
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
message/cpim — Message
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
GET/gmail/v1/users/{userId}/messages/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
format | query | no | string |
metadataHeaders | query | no | array |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
DELETE/gmail/v1/users/{userId}/messages/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
POST/gmail/v1/users/{userId}/messages/{id}/modify
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Request body
application/json — ModifyMessageRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
POST/gmail/v1/users/{userId}/messages/{id}/trash
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
POST/gmail/v1/users/{userId}/messages/{id}/untrash
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Message |
GET/gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
messageId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | MessagePartBody |
GET/gmail/v1/users/{userId}/profile
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Profile |
GET/gmail/v1/users/{userId}/settings/autoForwarding
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | AutoForwarding |
PUT/gmail/v1/users/{userId}/settings/autoForwarding
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — AutoForwarding
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | AutoForwarding |
GET/gmail/v1/users/{userId}/settings/cse/identities
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
pageSize | query | no | integer |
pageToken | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListCseIdentitiesResponse |
POST/gmail/v1/users/{userId}/settings/cse/identities
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — CseIdentity
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseIdentity |
GET/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
cseEmailAddress | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseIdentity |
DELETE/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
cseEmailAddress | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
PATCH/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
emailAddress | path | yes | string |
Request body
application/json — CseIdentity
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseIdentity |
GET/gmail/v1/users/{userId}/settings/cse/keypairs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
pageSize | query | no | integer |
pageToken | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListCseKeyPairsResponse |
POST/gmail/v1/users/{userId}/settings/cse/keypairs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — CseKeyPair
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseKeyPair |
GET/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
keyPairId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseKeyPair |
POST/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
keyPairId | path | yes | string |
Request body
application/json — DisableCseKeyPairRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseKeyPair |
POST/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
keyPairId | path | yes | string |
Request body
application/json — EnableCseKeyPairRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | CseKeyPair |
POST/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
keyPairId | path | yes | string |
Request body
application/json — ObliterateCseKeyPairRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/settings/delegates
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListDelegatesResponse |
POST/gmail/v1/users/{userId}/settings/delegates
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — Delegate
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Delegate |
GET/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
delegateEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Delegate |
DELETE/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
delegateEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/settings/filters
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListFiltersResponse |
POST/gmail/v1/users/{userId}/settings/filters
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — Filter
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Filter |
GET/gmail/v1/users/{userId}/settings/filters/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Filter |
DELETE/gmail/v1/users/{userId}/settings/filters/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/settings/forwardingAddresses
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListForwardingAddressesResponse |
POST/gmail/v1/users/{userId}/settings/forwardingAddresses
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — ForwardingAddress
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ForwardingAddress |
GET/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
forwardingEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ForwardingAddress |
DELETE/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
forwardingEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/settings/imap
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ImapSettings |
PUT/gmail/v1/users/{userId}/settings/imap
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — ImapSettings
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ImapSettings |
GET/gmail/v1/users/{userId}/settings/language
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | LanguageSettings |
PUT/gmail/v1/users/{userId}/settings/language
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — LanguageSettings
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | LanguageSettings |
GET/gmail/v1/users/{userId}/settings/pop
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | PopSettings |
PUT/gmail/v1/users/{userId}/settings/pop
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — PopSettings
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | PopSettings |
GET/gmail/v1/users/{userId}/settings/sendAs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListSendAsResponse |
POST/gmail/v1/users/{userId}/settings/sendAs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — SendAs
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | SendAs |
GET/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | SendAs |
PUT/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Request body
application/json — SendAs
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | SendAs |
PATCH/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Request body
application/json — SendAs
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | SendAs |
DELETE/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListSmimeInfoResponse |
POST/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Request body
application/json — SmimeInfo
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | SmimeInfo |
GET/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | SmimeInfo |
DELETE/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
POST/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
POST/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
sendAsEmail | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/settings/vacation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | VacationSettings |
PUT/gmail/v1/users/{userId}/settings/vacation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — VacationSettings
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | VacationSettings |
POST/gmail/v1/users/{userId}/stop
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
GET/gmail/v1/users/{userId}/threads
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
includeSpamTrash | query | no | boolean |
labelIds | query | no | array |
maxResults | query | no | integer |
pageToken | query | no | string |
q | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | ListThreadsResponse |
GET/gmail/v1/users/{userId}/threads/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
format | query | no | string |
metadataHeaders | query | no | array |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Thread |
DELETE/gmail/v1/users/{userId}/threads/{id}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | — |
POST/gmail/v1/users/{userId}/threads/{id}/modify
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Request body
application/json — ModifyThreadRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Thread |
POST/gmail/v1/users/{userId}/threads/{id}/trash
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Thread |
POST/gmail/v1/users/{userId}/threads/{id}/untrash
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | Thread |
POST/gmail/v1/users/{userId}/watch
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Request body
application/json — WatchRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful response | WatchResponse |
Try it
Developer reference
Base URL
https://gmail.googleapis.comRate limit
Google's Gmail API usage-limits docs (developers.google.com/workspace/gmail/api/reference/quota) publish a per-user-per-minute quota-unit model rather than flat request counts: each project gets 1,200,000 quota units/minute, and each user within it 6,000 quota units/minute, with individual methods costing a fixed number of units (messages.list is 5, messages.get is 20, messages.send is 100). Exceeding a limit returns a 403 with reason rateLimitExceeded/userRateLimitExceeded (or a 429 for daily/bandwidth/concurrency caps), and Google recommends truncated exponential backoff before retrying. Standard use remains free; Google's docs note billing on quota overage is planned to start later in 2026.
Key endpoints
- GET/gmail/v1/users/{userId}/profile
- GET/gmail/v1/users/{userId}/messages
- GET/gmail/v1/users/{userId}/messages/{id}
- POST/gmail/v1/users/{userId}/messages/send
- GET/gmail/v1/users/{userId}/labels