SecureAgentMail

Get inbox

Retrieves a single inbox by its slug. The response includes `flagged_count` and `withheld_count` counters in addition to the standard inbox fields.

GET
/inboxes/{slug}

Authorization

BearerAuth
AuthorizationBearer <token>

API key passed as a Bearer token. Production keys start with am_live_ and sandbox keys start with am_test_.

In: header

Path Parameters

slug*string

The unique slug identifier of the inbox.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://secureagentmail.com/api/v1/inboxes/string"
{
  "id": "inb_abc123",
  "slug": "support-bot",
  "display_name": "Support Bot",
  "address": "[email protected]",
  "security_level": "guarded_send",
  "status": "active",
  "message_count": 142,
  "created_at": "2026-01-15T08:30:00Z",
  "updated_at": "2026-02-20T14:00:00Z",
  "flagged_count": 3,
  "withheld_count": 1
}
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key.",
    "status": 401
  }
}
{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "status": 404
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Please retry after 30 seconds.",
    "status": 429
  }
}

Create inbox

Provisions a new agent inbox with the given slug. The inbox is immediately active and ready to receive mail at `{slug}@agents.agentmail.io`. The `security_level` determines which scanning and send policies are enforced.

Update inbox

Updates one or more mutable fields on the inbox. Only the fields present in the request body are changed; all others remain unchanged.