# Google Gmail Users API

**Canonical:** https://apis.io/apis/google-gmail/google-gmail-users-api/  
**Provider:** Google Gmail — https://apis.io/providers/google-gmail/  
**Base URL:** https://gmail.googleapis.com  
**Documentation:** https://developers.google.com/workspace/gmail/api/guides

Google Gmail Users API is one of 4 APIs that [Google Gmail](https://apis.io/providers/google-gmail/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a JSON-LD context, and 1 JSON Schema.

The Users API from Google Gmail — 48 operation(s) for users.

## Operations (60 of 79)

| Method | Path | Summary |
|---|---|---|
| POST | `/gmail/v1/users/{userId}/stop` | Stop users |
| POST | `/gmail/v1/users/{userId}/watch` | Watch users |
| GET | `/gmail/v1/users/{userId}/profile` | Get profile users |
| PUT | `/gmail/v1/users/{userId}/settings/imap` | Update imap settings |
| GET | `/gmail/v1/users/{userId}/settings/imap` | Get imap settings |
| PUT | `/gmail/v1/users/{userId}/settings/vacation` | Update vacation settings |
| GET | `/gmail/v1/users/{userId}/settings/vacation` | Get vacation settings |
| GET | `/gmail/v1/users/{userId}/settings/autoForwarding` | Get auto forwarding settings |
| PUT | `/gmail/v1/users/{userId}/settings/autoForwarding` | Update auto forwarding settings |
| PUT | `/gmail/v1/users/{userId}/settings/pop` | Update pop settings |
| GET | `/gmail/v1/users/{userId}/settings/pop` | Get pop settings |
| PUT | `/gmail/v1/users/{userId}/settings/language` | Update language settings |
| GET | `/gmail/v1/users/{userId}/settings/language` | Get language settings |
| POST | `/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate` | Obliterate keypairs |
| GET | `/gmail/v1/users/{userId}/settings/cse/keypairs` | List keypairs |
| POST | `/gmail/v1/users/{userId}/settings/cse/keypairs` | Create keypairs |
| POST | `/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable` | Disable keypairs |
| POST | `/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable` | Enable keypairs |
| GET | `/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}` | Get keypairs |
| GET | `/gmail/v1/users/{userId}/settings/cse/identities` | List identities |
| POST | `/gmail/v1/users/{userId}/settings/cse/identities` | Create identities |
| GET | `/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}` | Get identities |
| PATCH | `/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}` | Patch identities |
| DELETE | `/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}` | Delete identities |
| POST | `/gmail/v1/users/{userId}/settings/filters` | Create filters |
| GET | `/gmail/v1/users/{userId}/settings/filters` | List filters |
| GET | `/gmail/v1/users/{userId}/settings/filters/{id}` | Get filters |
| DELETE | `/gmail/v1/users/{userId}/settings/filters/{id}` | Delete filters |
| DELETE | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}` | Delete sendAs |
| PATCH | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}` | Patch sendAs |
| GET | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}` | Get sendAs |
| PUT | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}` | Update sendAs |
| POST | `/gmail/v1/users/{userId}/settings/sendAs` | Create sendAs |
| GET | `/gmail/v1/users/{userId}/settings/sendAs` | List sendAs |
| POST | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify` | Verify sendAs |
| GET | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}` | Get smimeInfo |
| DELETE | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}` | Delete smimeInfo |
| POST | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo` | Insert smimeInfo |
| GET | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo` | List smimeInfo |
| POST | `/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault` | Set default smimeInfo |
| GET | `/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}` | Get delegates |
| DELETE | `/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}` | Delete delegates |
| GET | `/gmail/v1/users/{userId}/settings/delegates` | List delegates |
| POST | `/gmail/v1/users/{userId}/settings/delegates` | Create delegates |
| DELETE | `/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}` | Delete forwardingAddresses |
| GET | `/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}` | Get forwardingAddresses |
| GET | `/gmail/v1/users/{userId}/settings/forwardingAddresses` | List forwardingAddresses |
| POST | `/gmail/v1/users/{userId}/settings/forwardingAddresses` | Create forwardingAddresses |
| GET | `/gmail/v1/users/{userId}/drafts` | List drafts |
| POST | `/gmail/v1/users/{userId}/drafts` | Create drafts |
| GET | `/gmail/v1/users/{userId}/drafts/{id}` | Get drafts |
| DELETE | `/gmail/v1/users/{userId}/drafts/{id}` | Delete drafts |
| PUT | `/gmail/v1/users/{userId}/drafts/{id}` | Update drafts |
| POST | `/gmail/v1/users/{userId}/drafts/send` | Send drafts |
| GET | `/gmail/v1/users/{userId}/history` | List history |
| POST | `/gmail/v1/users/{userId}/messages/send` | Send messages |
| GET | `/gmail/v1/users/{userId}/messages/{id}` | Get messages |
| DELETE | `/gmail/v1/users/{userId}/messages/{id}` | Delete messages |
| POST | `/gmail/v1/users/{userId}/messages/import` | Import messages |
| POST | `/gmail/v1/users/{userId}/messages/batchModify` | Batch modify messages |

…and 19 more operations. They are listed in full on the page.

## Machine-readable artifacts (6)

- **OpenAPI** — https://artifacts.apis.io/google-gmail/openapi/google-gmail-users-api-openapi.yml
- **Documentation** — https://developers.google.com/workspace/gmail/api/reference/rest
- **Authentication** — https://developers.google.com/workspace/gmail/api/auth/about-auth
- **GettingStarted** — https://developers.google.com/workspace/gmail/api/guides
- **JSONLD** — https://artifacts.apis.io/google-gmail/json-ld/json-ld.jsonld
- **JSONSchema** — https://artifacts.apis.io/google-gmail/json-schema/json-schema.yml

## Other Google Gmail APIs (3)

- [Gmail MCP Server](https://apis.io/apis/google-gmail/google-gmail-mcp-server/)
- [Google Gmail Domains API](https://apis.io/apis/google-gmail/google-gmail-domains-api/)
- [Google Gmail Domain Stats API](https://apis.io/apis/google-gmail/google-gmail-domainstats-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/google-gmail/google-gmail-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/google-gmail/.
