# Gmail Postmaster Tools API API

> Gmail Postmaster Tools API API on Apizie: 10 endpoints (Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't…, Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of…, [Developer Preview](https://developers.google.com/workspace/preview): Adds a domain to the user's account.…, [Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a…, …) 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://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.

## Endpoints

### Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domain-stats-batch-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of…
`GET https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The… |
| pageToken | string | no | Optional. The next_page_token value returned from a previous List request, if any. |

### [Developer Preview](https://developers.google.com/workspace/preview): Adds a domain to the user's account.…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### [Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a…
`GET https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-users-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the user to retrieve. Format: `domains/{domain}/users/{user}` |

### [Developer Preview](https://developers.google.com/workspace/preview): Updates a user for a domain. Only…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-users-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| updateMask | string | no | The list of fields to update. |
| body | object | yes | JSON request body |

### [Developer Preview](https://developers.google.com/workspace/preview): Deletes a user from a domain. Returns…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-users-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the user to delete. Format: domains/{domain}/users/{user} |

### [Developer Preview](https://developers.google.com/workspace/preview): Verifies a user's ownership of a…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The domain to verify. |
| body | object | yes | JSON request body |

### Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-domain-stats-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent resource name where the stats are queried. Format: domains/{domain} |
| body | object | yes | JSON request body |

### [Developer Preview](https://developers.google.com/workspace/preview): Lists the users that have access to a…
`GET https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-users-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. Requested page size. Server may return fewer users than requested. If unspecified, the default value for this field is 10. The… |
| pageToken | string | no | Optional. The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. The parent resource name for which to list users. Format: `domains/{domain}` |

### [Developer Preview](https://developers.google.com/workspace/preview): Creates a user, who has access to a…
`POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domains-users-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent resource where this user will be created. Format: domains/{domain} |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domain-stats-batch-query" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Gmail Postmaster Tools API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/analytics:googleapis-gmailpostmastertools/gmailpostmastertools-domain-stats-batch-query with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Gmail Postmaster Tools API API?
Yes. Add the Apizie MCP server (https://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-gmailpostmastertools.

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