---
title: "Past deliverability checks"
method: GET
path: "/v1/deliverability/checks"
tags: ["Deliverability"]
---

# Past deliverability checks

`GET /v1/deliverability/checks`

## Request

- Base URL: `https://api.kawaa.com`
- URL: `https://api.kawaa.com/v1/deliverability/checks`
- Auth: one of:
  - API key in header `X-Api-Key`
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.kawaa.com/oauth/authorize`, token URL `https://api.kawaa.com/oauth/token`, scopes: `deliverability:read`)

Past checks for this account, newest first, **within what was scanned**. Each request reads a bounded part of the account's history, in storage order rather than by date, and sorts only what it read, so on an account with a long history these are not necessarily the newest checks overall. `truncated: true` says that happened.

## Query parameters

- `limit` string

## Response `200`

Previous checks, newest first.

- object
  - `success` unknown, required
  - `data` object, required
    - `checks` object[], required
      - `check_id` string
      - `domain` string
      - `sending_ip` string, nullable
      - `score` integer, nullable: 0-100 over what was measured. Partial when `grade` is null; read the check itself (`GET /v1/deliverability/checks/{id}`) for `not_measured`.
      - `grade` string, nullable: The check's letter, or null when it has none: SPF, DKIM or DMARC could not be looked up (the rule `POST /v1/deliverability/check` applies), including on a check stored before that rule.
      - `checked_at` string, date-time
    - `count` integer, required: Rows in `checks`, at most the applied page size.
    - `total` integer, required: Rows SCANNED, not the account's total history. Equal to the history only when `truncated` is false.
    - `truncated` boolean, required: True when the scan stopped at its page bound. `checks` is then the newest of what was read, which is not the newest of what exists. There is no way to page past it on this route.

## Other responses

- `401`: No credential, or one that is not accepted. `code` distinguishes `API_KEY_SUSPENDED` (subscription ended; restartable) from `API_KEY_REVOKED`, `SESSION_EXPIRED` and `OAUTH_TOKEN_EXPIRED` (a connected app's one-hour access token lapsed: refresh it and retry, or sign in again if no refresh token was issued or the refresh is refused).
- `403`: Refused, and **the code says which of three problems it is**, and they need different remedies: - `INSUFFICIENT_SCOPE`: the credential is valid but not scoped for this route. With an API key, issue one that carries the scope named in the message. With an OAuth access token, connect the app again asking for that scope as well as the ones it has, unless the message says a connected app can never be given it; then use an API key with every scope the message names, or have the account owner do it in the dashboard. - `PLAN_UPGRADE_REQUIRED`: the account's plan does not include the feature. **No key of any scope reaches it**, so issuing another is wasted work; the remedy is a plan change. Returned by the verification routes for `options.enrich`, and by the finder, the monitors, the audit log, auto-clean and the white-label routes. - `PLAN_LIMIT_EXCEEDED`: the plan includes the feature and the account is at its ceiling (webhook endpoints, team seats, integrations, auto-clean lists). Delete one or upgrade. - `FORBIDDEN`: refused for a reason none of the above covers. `ErrorCode` is an open set, so branch on the code with a default rather than exhaustively.
- `429`: Too many requests. When the server knows how long to wait, `Retry-After` says so and `error.retry_after_seconds` carries the same number; the `X-RateLimit-*` headers say where you stand.
- `default`: Any status this operation does not list. Kawaa's own errors carry the error envelope. The gateway in front of the API can answer any operation with its own bare body (`GatewayError`): a `503` after about 29 seconds, when the request may still have run and been charged, a `413` for a body over about 6 MB, or a `400` for a path with malformed percent-encoding.

---

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