# Gmail Message (`gmail.message`)

Reads one message from the connected Gmail mailbox: headers, plain-text and HTML body, and the attachment list.

Docs: https://primaryapi.com/docs/api-reference/gmail/message

- Endpoint: `POST https://api.primaryapi.com/v1/run/gmail.message`
- Category: Knowledge & Data · Platform: `gmail` · Kind: lookup · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=gmail.message`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `id` | string | yes |  | pattern: ^[A-Za-z0-9_-]{1,64}$ | Gmail message id, as returned by gmail.search. |
| `maxBodyChars` | integer | no | 20000 | 100–200000 | Longest text and HTML body returned, in characters (default 20,000). |
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string |  |
| `threadId` | string \| null |  |
| `labelIds` | string[] |  |
| `snippet` | string \| null |  |
| `from` | string \| null |  |
| `to` | string \| null |  |
| `cc` | string \| null |  |
| `subject` | string \| null |  |
| `date` | string \| null | The Date header as sent |
| `receivedAt` | string \| null | When Gmail received it (ISO-8601) |
| `text` | string \| null | Plain-text body |
| `html` | string \| null | HTML body |
| `truncated` | boolean | True when a body was cut at maxBodyChars |
| `attachments` | object[] |  |
| `attachments[].filename` | string |  |
| `attachments[].mimeType` | string \| null |  |
| `attachments[].size` | integer \| null | Bytes |
| `attachments[].attachmentId` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/gmail.message" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"18c3a1f0e2b4d5f6"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "id": "18c3a1f0e2b4d5f6",
      "threadId": "18c3a1f0e2b4d5f6",
      "labelIds": [
        "INBOX",
        "UNREAD"
      ],
      "snippet": "Here are the numbers for October.",
      "from": "Alice Example <alice@example.com>",
      "to": "me@example.com",
      "cc": "bob@example.com",
      "subject": "October report",
      "date": "Mon, 02 Nov 2026 09:00:00 +0000",
      "receivedAt": "2026-11-02T09:00:00.000Z",
      "text": "Hi,\r\n\r\nHere are the numbers for October.\r\n\r\nAlice\r\n",
      "html": "<div>Hi,</div><div>Here are the numbers for October.</div><div>Alice</div>",
      "truncated": false,
      "attachments": [
        {
          "filename": "october-report.pdf",
          "mimeType": "application/pdf",
          "size": 48213,
          "attachmentId": "ANGjdJ8wTr1h0yQx"
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=gmail.message`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Runs as your connected Google account (read-only Gmail access). Attachment contents are not downloaded. A deleted or unknown message id is a miss (found: false).

