# get_site_email_bulk

Source: https://modulify.ai/docs/api/emails/get-site-email-bulk

Reads one bulk email of a site with its status, its recipient and delivery counts, what it said and a page of its recipients.

- Title: Read one bulk email of a site
- Scope: `config:read`
- Access: Read only
- Endpoint: `POST /v1/get_site_email_bulk`

`status` is `sending`, `paused` while it waits for sending to be turned back on, for a secret of the site to stop overriding its email settings, for credits, for a spending cap to lift, for next month or for the mail provider, `completed`, `canceled` or `stopped`, with the reason in `pausedReason` and `stopReason`. A paused one carries on by itself once it can, and a stopped one never starts again. `counts` holds `total`, `pending`, `sent`, `suppressed`, `failed` and `canceled`, and `delivery` holds `delivered`, `bounced`, `complained`, `tracked`, `opened` and `clicked`. `html` and `text` are the bulk email as it was queued, before each person's details were filled in.

Recipients come oldest first, each with their own email, so `get_site_email` with a recipient's `sendId` reads that person's delivery in full. Pass `nextCursor` back as `cursor` for the next page. Rows are kept until the history is cleared. See [Follow and cancel a bulk email](https://modulify.ai/docs/built-in/emails#follow-and-cancel-a-bulk-email).

## Request

Call it with a `POST` to `https://api.modulify.ai/v1/get_site_email_bulk`, sending the inputs below as a JSON object. The token needs the `config:read` scope.

It only reads and changes nothing, so retrying it is safe.

```bash
curl -X POST https://api.modulify.ai/v1/get_site_email_bulk \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID","id":"ID"}'
```

Over MCP, the same method is the [get_site_email_bulk tool](https://modulify.ai/docs/mcp/emails/get-site-email-bulk).

## Inputs

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | string | Yes | The site id. |
| `id` | string | Yes | The id of the bulk email, from `send_site_email_bulk` or `list_site_email_bulks`. |
| `status` | string | No | Keep only the recipients with this status: `pending`, `sending`, `sent`, `suppressed`, `failed` or `canceled`. |
| `limit` | number | No | How many recipients to return, 20 by default and at most 100. |
| `cursor` | string | No | The `nextCursor` from the previous page, with the same `status`. Omit it for the first page. |

## Response

Every call answers with the [JSON envelope](https://modulify.ai/docs/api/requests-and-responses#the-response) of `success`, `message`, `data`, `code` and `version`. `data` holds the result described above, and on a method that returns a total, `count` carries it. The [response headers](https://modulify.ai/docs/api/requests-and-responses#headers-on-every-method-call) carry the call's `X-Request-Id` and what is left of your per-minute budget in `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. [Errors](https://modulify.ai/docs/api/errors) explains every status code a call can answer with.