# Gmail API API

> Gmail API API on Apizie: 79 endpoints (Gets the current user's Gmail profile., Turn off push notification delivery for the given user mailbox. For more information, see [Configure push…, Set up or update a push notification watch on the given user mailbox. For more information, see [Configure…, Lists the drafts in the user's mailbox. For more information, see [Create and send draft…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/analytics:googleapis-gmail/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-gmail`
- Category: Analytics
- Status: byok
- Source: https://developers.google.com/workspace/gmail/api/
- Page: https://www.apizie.tech/api/analytics/googleapis-gmail
- OpenAPI: https://www.apizie.tech/api/analytics/googleapis-gmail/openapi.json

The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.

## Endpoints

### Gets the current user's Gmail profile.
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-get-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Turn off push notification delivery for the given user mailbox. For more information, see [Configure push…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-stop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Set up or update a push notification watch on the given user mailbox. For more information, see [Configure…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-watch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Lists the drafts in the user's mailbox. For more information, see [Create and send draft…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-drafts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| includeSpamTrash | boolean | no | Include drafts from `SPAM` and `TRASH` in the results. |
| maxResults | integer | no | Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500. |
| pageToken | string | no | Page token to retrieve a specific page of results in the list. |
| q | string | no | Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example,… |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Creates a draft with the `DRAFT` label. For more information, see [Create and send draft…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-drafts-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets the specified draft. For more information, see [Create and send draft…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-drafts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | The format to return the draft in. |
| id | string | yes | The ID of the draft to retrieve. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Replaces a draft's content. For more information, see [Create and send draft…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-drafts-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the draft to update. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Immediately and permanently deletes the specified draft. Does not simply trash it. For more information, see…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-drafts-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the draft to delete. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. For more…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-drafts-send` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Lists the history of all changes to the given mailbox. History results are returned in chronological order…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-history-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| historyTypes | string | no | History types to be returned by the function |
| labelId | string | no | Only return messages with a label matching the ID. |
| maxResults | integer | no | Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500. |
| pageToken | string | no | Page token to retrieve a specific page of results in the list. |
| startHistoryId | string | no | Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the… |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Lists all labels in the user's mailbox. For more information, see [Manage…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-labels-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Creates a label. For more information, see [Manage…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-labels-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets the specified label. For more information, see [Manage…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-labels-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the label to retrieve. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Updates the specified label. For more information, see [Manage…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-labels-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the label to update. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Patch the specified label. For more information, see [Manage…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-labels-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the label to update. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Immediately and permanently deletes the specified label and removes it from any messages and threads that…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-labels-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the label to delete. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-batch-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Modifies the labels and the Classification Label values on the specified messages. For administrators…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-batch-modify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets the specified message.
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | The format to return the message in. |
| id | string | yes | The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a… |
| metadataHeaders | string | no | When given and format is `METADATA`, only include headers specified. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the message to delete. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Imports a message into only this user's mailbox, with standard email delivery scanning and classification…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| deleted | boolean | no | Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google… |
| internalDateSource | string | no | Source for Gmail's internal date of the message. |
| neverMarkSpam | boolean | no | Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. |
| processForCalendar | boolean | no | Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Lists the messages in the user's mailbox. For more information, see [List Gmail…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| includeSpamTrash | boolean | no | Include messages from `SPAM` and `TRASH` in the results. |
| labelIds | string | no | Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in… |
| maxResults | integer | no | Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500. |
| pageToken | string | no | Page token to retrieve a specific page of results in the list. |
| q | string | no | Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example,… |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-insert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| deleted | boolean | no | Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google… |
| internalDateSource | string | no | Source for Gmail's internal date of the message. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Modifies the labels and the Classification Label values on the specified message. For administrators…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-modify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the message to modify. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information,…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-send` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Moves the specified message to the trash.
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-trash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the message to Trash. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Removes the specified message from the trash.
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-untrash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the message to remove from Trash. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Gets the specified message attachment.
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-messages-attachments-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the attachment. |
| messageId | string | yes | The ID of the message containing the attachment. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Gets the auto-forwarding setting for the specified account. For more information, see [Manage email…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-get-auto-forwarding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Updates the auto-forwarding setting for the specified account. A verified forwarding address must be…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-update-auto-forwarding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-get-imap` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Updates IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-update-imap` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets language settings. For more information, see [Manage language…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-get-language` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Updates language settings. For more information, see [Manage language…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-update-language` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets POP settings. For more information, see [Configure POP and IMAP settings with the Gmail…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-get-pop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Updates POP settings. For more information, see [Configure POP and IMAP settings with the Gmail…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-update-pop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets vacation responder settings. For more information, see [Manage vacation settings with the Gmail…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-get-vacation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Updates vacation responder settings. For more information, see [Manage vacation settings with the Gmail…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-update-vacation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Lists the client-side encrypted identities for an authenticated user. For administrators managing identities…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-identities-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The number of identities to return. If not provided, the page size will default to 20 entries. |
| pageToken | string | no | Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of… |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |

### Creates and configures a client-side encryption identity that's authorized to send mail from the user…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-identities-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |
| body | object | yes | JSON request body |

### Retrieves a client-side encryption identity configuration. For administrators managing identities and…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-identities-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cseEmailAddress | string | yes | The primary email address associated with the client-side encryption identity configuration that's retrieved. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |

### Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-identities-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cseEmailAddress | string | yes | The primary email address associated with the client-side encryption identity configuration that's removed. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |

### Associates a different key pair with an existing client-side encryption identity. The updated key pair must…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-identities-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| emailAddress | string | yes | The email address of the client-side encryption identity to update. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |
| body | object | yes | JSON request body |

### Lists client-side encryption key pairs for an authenticated user. For administrators managing identities and…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-keypairs-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The number of key pairs to return. If not provided, the page size will default to 20 entries. |
| pageToken | string | no | Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of… |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |

### Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-keypairs-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| chainValidation | string | no | The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the… |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |
| body | object | yes | JSON request body |

### Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-keypairs-disable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyPairId | string | yes | The identifier of the key pair to turn off. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |
| body | object | yes | JSON request body |

### Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-keypairs-enable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyPairId | string | yes | The identifier of the key pair to turn on. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |
| body | object | yes | JSON request body |

### Retrieves an existing client-side encryption key pair. For administrators managing identities and keypairs…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-keypairs-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyPairId | string | yes | The identifier of the key pair to retrieve. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |

### Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-cse-keypairs-obliterate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyPairId | string | yes | The identifier of the key pair to obliterate. |
| userId | string | yes | The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |
| body | object | yes | JSON request body |

### Lists the delegates for the specified account. For more information, see [Manage…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-delegates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Adds a delegate with its verification status set directly to `accepted`, without sending any verification…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-delegates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets the specified delegate. For more information, see [Manage…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-delegates-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| delegateEmail | string | yes | The email address of the user whose delegate relationship is to be retrieved. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Removes the specified delegate (which can be of any verification status), and revokes any verification that…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-delegates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| delegateEmail | string | yes | The email address of the user to be removed as a delegate. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Lists the message filters of a Gmail user. For more information, see [Manage Gmail…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-filters-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Creates a filter. Note: you can only create a maximum of 1,000 filters. For more information, see [Manage…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-filters-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets a filter. For more information, see [Manage Gmail…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-filters-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the filter to be fetched. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Immediately and permanently deletes the specified filter. For more information, see [Manage Gmail…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-filters-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the filter to be deleted. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Lists the forwarding addresses for the specified account. For more information, see [Manage email…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-forwarding-addresses-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-forwarding-addresses-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets the specified forwarding address. For more information, see [Manage email…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-forwarding-addresses-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| forwardingEmail | string | yes | The forwarding address to be retrieved. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Deletes the specified forwarding address and revokes any verification that may have been required. For more…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-forwarding-addresses-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| forwardingEmail | string | yes | The forwarding address to be deleted. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Lists the send-as aliases for the specified account. The result includes the primary send-as address…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The send-as alias to be retrieved. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The send-as alias to be updated. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Patch the specified send-as alias. For more information, see [Manage aliases and signatures with the Gmail…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The send-as alias to be updated. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Deletes the specified send-as alias. Revokes any verification that may have been required for using it. For…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The send-as alias to be deleted. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Sends a verification email to the specified send-as alias address. The verification status must be…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The send-as alias to be verified. |
| userId | string | yes | User's email address. The special value "me" can be used to indicate the authenticated user. |

### Gets the specified S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-smime-info-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The immutable ID for the SmimeInfo. |
| sendAsEmail | string | yes | The email address that appears in the "From:" header for mail sent using this alias. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Deletes the specified S/MIME config for the specified send-as alias. For more information, see [Manage…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-smime-info-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The immutable ID for the SmimeInfo. |
| sendAsEmail | string | yes | The email address that appears in the "From:" header for mail sent using this alias. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Lists S/MIME configs for the specified send-as alias. For more information, see [Manage S/MIME certificates…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-smime-info-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The email address that appears in the "From:" header for mail sent using this alias. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Insert (upload) the given S/MIME config for the specified send-as alias. Note that `pkcs12` format is…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-smime-info-insert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sendAsEmail | string | yes | The email address that appears in the "From:" header for mail sent using this alias. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Sets the default S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-settings-send-as-smime-info-set-default` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The immutable ID for the SmimeInfo. |
| sendAsEmail | string | yes | The email address that appears in the "From:" header for mail sent using this alias. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Gets the specified thread. For more information, see [Manage…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-threads-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | The format to return the messages in. |
| id | string | yes | The ID of the thread to retrieve. |
| metadataHeaders | string | no | When given and format is METADATA, only include headers specified. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-threads-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the Thread to delete. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Lists the threads in the user's mailbox. For more information, see [Manage…
`GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-threads-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| includeSpamTrash | boolean | no | Include threads from `SPAM` and `TRASH` in the results. |
| labelIds | string | no | Only return threads with labels that match all of the specified label IDs. |
| maxResults | integer | no | Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500. |
| pageToken | string | no | Page token to retrieve a specific page of results in the list. |
| q | string | no | Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example,… |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Modifies the labels applied to the thread. This applies to all messages in the thread. For more information,…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-threads-modify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the thread to modify. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |
| body | object | yes | JSON request body |

### Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-threads-trash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the thread to Trash. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

### Removes the specified thread from the trash. Any messages that belong to the thread are also removed from…
`POST https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-threads-untrash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the thread to remove from Trash. |
| userId | string | yes | The user's email address. The special value `me` can be used to indicate the authenticated user. |

## Example
```
curl "https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-get-profile" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Gmail API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/analytics:googleapis-gmail/gmail-users-get-profile with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Gmail API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Gmail API itself also needs your own key from googleapis.com.

### Can AI agents use the Gmail API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-gmail.

### What is the status of the Gmail API API?
Needs your own provider key (bring your own key)