---
title: "Diagnose sending and receiving problems in the workspace"
method: GET
path: "/account/diagnostics"
tags: ["Account and billing"]
---

# Diagnose sending and receiving problems in the workspace

`GET /account/diagnostics`

## Request

- Base URL: `https://sendhq.cc/api/v1`
- URL: `https://sendhq.cc/api/v1/account/diagnostics`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sendhq/apis/sendhq-api/docs/account/diagnostics/get.ts> (a function with typed inputs; its response is checked against the schema)

Read-only troubleshooting snapshot from stored state: an `issues` list in plain language, plan and usage against limits, each domain's DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, the last 30 days of messages that were not sent with their reasons, bounce, complaint and reject events, and webhook delivery health. Never returns message bodies, API keys or webhook secrets.

## Response `200`

Successful response

- object
  - `generatedAt` string, date-time, required
  - `windowDays` integer, required
  - `issues` object[], required
    - `severity` string, required
    - `code` string, required
    - `message` string, required
  - `plan` object, required
  - `domains` unknown[], required
    - unknown
  - `sendingIdentities` object, required
    - `domains` unknown[], required
      - unknown
    - `addresses` unknown[], required
      - unknown
  - `inbound` object, required
  - `deliverability` object, required
  - `suppressions` object, required
  - `failures` object, required
    - `notSent` unknown[], required
      - unknown
    - `recentNotSent` unknown[], required
      - unknown
    - `recentProviderEvents` unknown[], required
      - unknown
  - `webhooks` unknown[], required
    - unknown

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid authentication
- `402`: A paid entitlement is required for this recipient or feature
- `403`: The workspace, domain, policy, or suppression state forbids the operation
- `404`: Tenant-scoped resource not found
- `409`: Resource state or idempotency conflict
- `413`: Attachment count or bytes exceed the accepted limit
- `422`: Request validation or suppression check failed
- `423`: Sending is paused for this sender identity or workspace; the message gives the reason and how to appeal
- `429`: A monthly, daily, or trial usage limit was reached
- `500`: Unexpected server error
- `502`: An upstream provider operation failed
- `503`: A required provider or signing configuration is unavailable
- `default`: An error response using SendHQ's standard JSON envelope

---

[API](https://skmtc.dev/sendhq/apis/sendhq-api.md) - [All operations](https://skmtc.dev/sendhq/apis/sendhq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sendhq/apis/sendhq-api/revisions/98e39e48cb9a?raw)
