Lap-Platform Gmail API
API version: v1
Auth
OAuth2 | OAuth2
Base URL
Setup
- Configure auth: OAuth2 | OAuth2
- GET /gmail/v1/users/{userId}/drafts -- verify access
- POST /gmail/v1/users/{userId}/drafts -- create first drafts
Endpoints
79 endpoints across 1 groups. See references/api-spec.lap for full details.
gmail
| Method | Path | Description |
|---|---|---|
| GET | /gmail/v1/users/{userId}/drafts | Lists the drafts in the user's mailbox. |
| POST | /gmail/v1/users/{userId}/drafts | Creates a new draft with the DRAFT label. |
| POST | /gmail/v1/users/{userId}/drafts/send | Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. |
| DELETE | /gmail/v1/users/{userId}/drafts/{id} | Immediately and permanently deletes the specified draft. Does not simply trash it. |
| GET | /gmail/v1/users/{userId}/drafts/{id} | Gets the specified draft. |
| PUT | /gmail/v1/users/{userId}/drafts/{id} | Replaces a draft's content. |
| GET | /gmail/v1/users/{userId}/history | Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). |
| GET | /gmail/v1/users/{userId}/labels | Lists all labels in the user's mailbox. |
| POST | /gmail/v1/users/{userId}/labels | Creates a new label. |
| DELETE | /gmail/v1/users/{userId}/labels/{id} | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. |
| GET | /gmail/v1/users/{userId}/labels/{id} | Gets the specified label. |
| PATCH | /gmail/v1/users/{userId}/labels/{id} | Patch the specified label. |
| PUT | /gmail/v1/users/{userId}/labels/{id} | Updates the specified label. |
| GET | /gmail/v1/users/{userId}/messages | Lists the messages in the user's mailbox. |
| POST | /gmail/v1/users/{userId}/messages | Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. |
| POST | /gmail/v1/users/{userId}/messages/batchDelete | Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. |
| POST | /gmail/v1/users/{userId}/messages/batchModify | Modifies the labels on the specified messages. |
| POST | /gmail/v1/users/{userId}/messages/import | Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user. |
| POST | /gmail/v1/users/{userId}/messages/send | Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email. |
| DELETE | /gmail/v1/users/{userId}/messages/{id} | Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. |
| GET | /gmail/v1/users/{userId}/messages/{id} | Gets the specified message. |
| POST | /gmail/v1/users/{userId}/messages/{id}/modify | Modifies the labels on the specified message. |
| POST | /gmail/v1/users/{userId}/messages/{id}/trash | Moves the specified message to the trash. |
| POST | /gmail/v1/users/{userId}/messages/{id}/untrash | Removes the specified message from the trash. |
| GET | /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id} | Gets the specified message attachment. |
| GET | /gmail/v1/users/{userId}/profile | Gets the current user's Gmail profile. |
| GET | /gmail/v1/users/{userId}/settings/autoForwarding | Gets the auto-forwarding setting for the specified account. |
| PUT | /gmail/v1/users/{userId}/settings/autoForwarding | Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/cse/identities | Lists the client-side encrypted identities for an authenticated user. |
| POST | /gmail/v1/users/{userId}/settings/cse/identities | Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. |
| DELETE | /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress} | Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. |
| GET | /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress} | Retrieves a client-side encryption identity configuration. |
| PATCH | /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress} | Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles. |
| GET | /gmail/v1/users/{userId}/settings/cse/keypairs | Lists client-side encryption key pairs for an authenticated user. |
| POST | /gmail/v1/users/{userId}/settings/cse/keypairs | Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. |
| GET | /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId} | Retrieves an existing client-side encryption key pair. |
| POST | /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable | Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. |
| POST | /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable | Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. |
| POST | /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate | Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. |
| GET | /gmail/v1/users/{userId}/settings/delegates | Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority. |
| POST | /gmail/v1/users/{userId}/settings/delegates | Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same Google Workspace organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. |
| DELETE | /gmail/v1/users/{userId}/settings/delegates/{delegateEmail} | Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/delegates/{delegateEmail} | Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/filters | Lists the message filters of a Gmail user. |
| POST | /gmail/v1/users/{userId}/settings/filters | Creates a filter. Note: you can only create a maximum of 1,000 filters. |
| DELETE | /gmail/v1/users/{userId}/settings/filters/{id} | Immediately and permanently deletes the specified filter. |
| GET | /gmail/v1/users/{userId}/settings/filters/{id} | Gets a filter. |
| GET | /gmail/v1/users/{userId}/settings/forwardingAddresses | Lists the forwarding addresses for the specified account. |
| POST | /gmail/v1/users/{userId}/settings/forwardingAddresses | Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. |
| DELETE | /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail} | Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail} | Gets the specified forwarding address. |
| GET | /gmail/v1/users/{userId}/settings/imap | Gets IMAP settings. |
| PUT | /gmail/v1/users/{userId}/settings/imap | Updates IMAP settings. |
| GET | /gmail/v1/users/{userId}/settings/language | Gets language settings. |
| PUT | /gmail/v1/users/{userId}/settings/language | Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. |
| GET | /gmail/v1/users/{userId}/settings/pop | Gets POP settings. |
| PUT | /gmail/v1/users/{userId}/settings/pop | Updates POP settings. |
| GET | /gmail/v1/users/{userId}/settings/sendAs | Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. |
| POST | /gmail/v1/users/{userId}/settings/sendAs | Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. |
| DELETE | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} | Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} | Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. |
| PATCH | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} | Patch the specified send-as alias. |
| PUT | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} | Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo | Lists S/MIME configs for the specified send-as alias. |
| POST | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo | Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. |
| DELETE | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id} | Deletes the specified S/MIME config for the specified send-as alias. |
| GET | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id} | Gets the specified S/MIME config for the specified send-as alias. |
| POST | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault | Sets the default S/MIME config for the specified send-as alias. |
| POST | /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify | Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority. |
| GET | /gmail/v1/users/{userId}/settings/vacation | Gets vacation responder settings. |
| PUT | /gmail/v1/users/{userId}/settings/vacation | Updates vacation responder settings. |
| POST | /gmail/v1/users/{userId}/stop | Stop receiving push notifications for the given user mailbox. |
| GET | /gmail/v1/users/{userId}/threads | Lists the threads in the user's mailbox. |
| DELETE | /gmail/v1/users/{userId}/threads/{id} | Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer threads.trash instead. |
| GET | /gmail/v1/users/{userId}/threads/{id} | Gets the specified thread. |
| POST | /gmail/v1/users/{userId}/threads/{id}/modify | Modifies the labels applied to the thread. This applies to all messages in the thread. |
| POST | /gmail/v1/users/{userId}/threads/{id}/trash | Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. |
| POST | /gmail/v1/users/{userId}/threads/{id}/untrash | Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. |
| POST | /gmail/v1/users/{userId}/watch | Set up or update a push notification watch on the given user mailbox. |
Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Search drafts?" -> GET /gmail/v1/users/{userId}/drafts
- "Create a draft?" -> POST /gmail/v1/users/{userId}/drafts
- "Create a send?" -> POST /gmail/v1/users/{userId}/drafts/send
- "Delete a draft?" -> DELETE /gmail/v1/users/{userId}/drafts/{id}
- "Get draft details?" -> GET /gmail/v1/users/{userId}/drafts/{id}
- "Update a draft?" -> PUT /gmail/v1/users/{userId}/drafts/{id}
- "List all history?" -> GET /gmail/v1/users/{userId}/history
- "List all labels?" -> GET /gmail/v1/users/{userId}/labels
- "Create a label?" -> POST /gmail/v1/users/{userId}/labels
- "Delete a label?" -> DELETE /gmail/v1/users/{userId}/labels/{id}
- "Get label details?" -> GET /gmail/v1/users/{userId}/labels/{id}
- "Partially update a label?" -> PATCH /gmail/v1/users/{userId}/labels/{id}
- "Update a label?" -> PUT /gmail/v1/users/{userId}/labels/{id}
- "Search messages?" -> GET /gmail/v1/users/{userId}/messages
- "Create a message?" -> POST /gmail/v1/users/{userId}/messages
- "Create a batchDelete?" -> POST /gmail/v1/users/{userId}/messages/batchDelete
- "Create a batchModify?" -> POST /gmail/v1/users/{userId}/messages/batchModify
- "Create a import?" -> POST /gmail/v1/users/{userId}/messages/import
- "Create a send?" -> POST /gmail/v1/users/{userId}/messages/send
- "Delete a message?" -> DELETE /gmail/v1/users/{userId}/messages/{id}
- "Get message details?" -> GET /gmail/v1/users/{userId}/messages/{id}
- "Create a modify?" -> POST /gmail/v1/users/{userId}/messages/{id}/modify
- "Create a trash?" -> POST /gmail/v1/users/{userId}/messages/{id}/trash
- "Create a untrash?" -> POST /gmail/v1/users/{userId}/messages/{id}/untrash
- "Get attachment details?" -> GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
- "List all profile?" -> GET /gmail/v1/users/{userId}/profile
- "List all autoForwarding?" -> GET /gmail/v1/users/{userId}/settings/autoForwarding
- "List all identities?" -> GET /gmail/v1/users/{userId}/settings/cse/identities
- "Create a identity?" -> POST /gmail/v1/users/{userId}/settings/cse/identities
- "Delete a identity?" -> DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
- "Get identity details?" -> GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
- "Partially update a identity?" -> PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
- "List all keypairs?" -> GET /gmail/v1/users/{userId}/settings/cse/keypairs
- "Create a keypair?" -> POST /gmail/v1/users/{userId}/settings/cse/keypairs
- "Get keypair details?" -> GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
- "List all delegates?" -> GET /gmail/v1/users/{userId}/settings/delegates
- "Create a delegate?" -> POST /gmail/v1/users/{userId}/settings/delegates
- "Delete a delegate?" -> DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
- "Get delegate details?" -> GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
- "List all filters?" -> GET /gmail/v1/users/{userId}/settings/filters
- "Create a filter?" -> POST /gmail/v1/users/{userId}/settings/filters
- "Delete a filter?" -> DELETE /gmail/v1/users/{userId}/settings/filters/{id}
- "Get filter details?" -> GET /gmail/v1/users/{userId}/settings/filters/{id}
- "List all forwardingAddresses?" -> GET /gmail/v1/users/{userId}/settings/forwardingAddresses
- "Create a forwardingAddress?" -> POST /gmail/v1/users/{userId}/settings/forwardingAddresses
- "Delete a forwardingAddress?" -> DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
- "Get forwardingAddress details?" -> GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
- "List all imap?" -> GET /gmail/v1/users/{userId}/settings/imap
- "List all language?" -> GET /gmail/v1/users/{userId}/settings/language
- "List all pop?" -> GET /gmail/v1/users/{userId}/settings/pop
- "List all sendAs?" -> GET /gmail/v1/users/{userId}/settings/sendAs
- "Create a sendA?" -> POST /gmail/v1/users/{userId}/settings/sendAs
- "Delete a sendA?" -> DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
- "Get sendA details?" -> GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
- "Partially update a sendA?" -> PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
- "Update a sendA?" -> PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
- "List all smimeInfo?" -> GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
- "Create a smimeInfo?" -> POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
- "Delete a smimeInfo?" -> DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
- "Get smimeInfo details?" -> GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
- "Create a setDefault?" -> POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
- "Create a verify?" -> POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
- "List all vacation?" -> GET /gmail/v1/users/{userId}/settings/vacation
- "Create a stop?" -> POST /gmail/v1/users/{userId}/stop
- "Search threads?" -> GET /gmail/v1/users/{userId}/threads
- "Delete a thread?" -> DELETE /gmail/v1/users/{userId}/threads/{id}
- "Get thread details?" -> GET /gmail/v1/users/{userId}/threads/{id}
- "Create a modify?" -> POST /gmail/v1/users/{userId}/threads/{id}/modify
- "Create a trash?" -> POST /gmail/v1/users/{userId}/threads/{id}/trash
- "Create a untrash?" -> POST /gmail/v1/users/{userId}/threads/{id}/untrash
- "Create a watch?" -> POST /gmail/v1/users/{userId}/watch
- "How to authenticate?" -> See Auth section
Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
Generated from the official API spec by LAP