# List status — GET /v1/email/sendgrid/status

URL: https://docs.hanzo.ai/docs/openapi/email/get-email-sendgrid-status

> Reports the org's SendGrid configuration: whether it holds the credentials a send needs, the account's credits as SendGrid answers them, what the org's ledger counted sent by SendGrid in the last 24 hours, and the DNS records of the sending domain.

`GET /v1/email/sendgrid/status`

> [Email →](https://docs.hanzo.ai/docs/openapi/email) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/email/sendgrid/status` |
| **Method**    | `GET`                                           |
| **Operation** | `get_email_sendgrid_status`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`          |

Reports the org's SendGrid configuration: whether it holds the
credentials a send needs, the account's credits as SendGrid answers them, what
the org's ledger counted sent by SendGrid in the last 24 hours, and the DNS
records of the sending domain.

GET /v1/email/sendgrid/status

## Request

1 field.

| Field    | In    | Type   | Required | Description                                                                                                    |
| -------- | ----- | ------ | -------- | -------------------------------------------------------------------------------------------------------------- |
| `domain` | query | string | —        | Domain is an optional sending domain to generate SendGrid whitelabel DKIM, Return-Path, and DMARC records for. |

## Response

| Status    | Body                       | Meaning |
| --------- | -------------------------- | ------- |
| `200`     | email.SendGridStatusResult | ok      |
| `default` | problem-details            | refused |

`200` body — 22 fields.

| Field                         | In   | Type                  | Always | Description                                                                                                                                                                      |
| ----------------------------- | ---- | --------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `active_provider`             | body | string                | —      | ActiveProvider is the provider the org's mail leaves by when a request pins none.                                                                                                |
| `asm_group_id`                | body | string                | —      | ASMGroupID is the optional SendGrid suppression group ID.                                                                                                                        |
| `configured`                  | body | boolean               | —      | Configured reports whether the org holds the SendGrid credentials a send needs (api-key, from-email).                                                                            |
| `credits_remaining`           | body | integer (int64)       | —      | CreditsRemaining is the credits left in the period.                                                                                                                              |
| `credits_total`               | body | integer (int64)       | —      | CreditsTotal, CreditsRemaining and CreditsUsed are the account's sending credits for the period, as SendGrid answers them.                                                       |
| `credits_used`                | body | integer (int64)       | —      | CreditsUsed is the credits used in the period.                                                                                                                                   |
| `dns_records`                 | body | email.SESDNSRecord\[] | —      | DNSRecords lists the required SendGrid Domain Authentication CNAME, Link Branding, SPF, and DMARC DNS records.                                                                   |
| `dns_records[].host`          | body | string                | —      | Host is the DNS record host or subdomain name.                                                                                                                                   |
| `dns_records[].priority`      | body | integer (int64)       | —      | Priority is the MX priority when Type is MX.                                                                                                                                     |
| `dns_records[].purpose`       | body | string                | —      | Purpose describes the role of the DNS record (e.g. DKIM, MAIL FROM MX, MAIL FROM SPF, DMARC).                                                                                    |
| `dns_records[].type`          | body | string                | —      | Type is the DNS record type (CNAME, MX, TXT).                                                                                                                                    |
| `dns_records[].value`         | body | string                | —      | Value is the DNS record target or text value.                                                                                                                                    |
| `dns_records[].verified`      | body | boolean               | —      | Verified reports whether the DNS record is verified for the sending identity.                                                                                                    |
| `domain`                      | body | string                | —      | Domain is the sending domain used for SendGrid Domain Authentication and DMARC.                                                                                                  |
| `from_email`                  | body | string                | —      | FromEmail is the configured SendGrid outreach sender email address.                                                                                                              |
| `from_name`                   | body | string                | —      | FromName is the configured SendGrid outreach sender display name.                                                                                                                |
| `ip_pool`                     | body | string                | —      | IPPool is the SendGrid IP pool the credential names, if any.                                                                                                                     |
| `org`                         | body | string                | —      | Org is the organization identifier.                                                                                                                                              |
| `quota_error`                 | body | string                | —      | QuotaError says why the account's credits could not be read; they are then 0.                                                                                                    |
| `reply_to`                    | body | string                | —      | ReplyTo is the configured Reply-To address for outreach replies.                                                                                                                 |
| `sent_last_24_hours`          | body | integer (int64)       | —      | SentLast24Hours is what the org's ledger counts sent by SendGrid in the last 24 hours: through POST /v1/email, and every message SendGrid's events told of.                      |
| `separate_from_twilio_notify` | body | boolean               | —      | SeparateFromTwilioNotify confirms that SendGrid outreach uses its own dedicated API key, sender identity, and IP pool distinct from standard Twilio transactional notifications. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo email sendgrid status
```

**SDK**

**.ts**

```ts
import { Configuration, EmailApi } from 'hanzoai';

const api = new EmailApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getEmailSendgridStatus();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import EmailApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = EmailApi(client).get_email_sendgrid_status()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.EmailAPI.GetEmailSendgridStatus(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, email_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = email_api::get_email_sendgrid_status(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.EmailApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new EmailApi(client).getEmailSendgridStatus();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/email/sendgrid/status \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `email`, op `get_email_sendgrid_status` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "email",
         "arguments": {
           "op": "get_email_sendgrid_status",
           "input": {}
         }
       }
     }'
```

---

[Email API](https://docs.hanzo.ai/docs/openapi/email) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
