---
title: "List mail held back from agents"
method: GET
path: "/api/v1/holds"
tags: ["Agent inboxes"]
---

# List mail held back from agents

`GET /api/v1/holds`

## Request

- Base URL: `https://supermailos.com`
- URL: `https://supermailos.com/api/v1/holds`
- Auth: HTTP bearer

Conversations an agent can't see yet: the sender failed authentication, is blocked, or isn't allowed by the inbox's `inboundMode`. People's keys only.

## Query parameters

- `inbox` string
- `status` 'held' | 'released' | 'dismissed'
- `limit` integer

## Response `200`

Held mail.

- object
  - `holds` AgentHold[], required
    - `id` string, required
    - `inboxId` string, required
    - `threadId` string, required: Hidden from the agent's key while held or dismissed.
    - `emailId` string, nullable
    - `sender` string, email, required
    - `reason` 'auth_failed' | 'blocked_sender' | 'not_allowlisted' | 'unverified_sender', required
    - `reasonText` string, required
    - `verdict` 'verified' | 'unverified' | 'failed', required
    - `auth` object
      - `spf` string
      - `dkim` string
      - `dmarc` string
    - `status` 'held' | 'released' | 'dismissed', required
    - `createdAt` string, date-time, required
    - `decidedAt` string, date-time

## Other responses

- `400`: The request is malformed.
- `401`: Missing, invalid or revoked API key.
- `403`: The key lacks the scope (`missing_scope`) or the access (`forbidden`).
- `404`: Not found — or not reachable with this key.
- `429`: Too many requests.

---

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