Skip to main content
GET
/
v1
/
api
/
email
/
review
List emails awaiting review
curl --request GET \
  --url https://api.hq.zone/v1/api/email/review \
  --header 'Authorization: Bearer <token>'
{
  "awaiting_review": [
    {
      "direction": "<string>",
      "email_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from_addr": "<string>",
      "handling_state": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "to_addrs": [
        "<string>"
      ],
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "endpoint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "endpoint_localpart": "<string>",
      "endpoint_plane": "<string>",
      "llm_category": "<string>",
      "llm_summary": "<string>",
      "subject": "<string>"
    }
  ],
  "counts": {
    "awaiting_review": 123,
    "quarantined": 123,
    "unrouted": 123
  },
  "quarantined": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "from_addr": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reason": "<string>",
      "sentio_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "to_addr": "<string>",
      "llm_category": "<string>",
      "llm_summary": "<string>"
    }
  ],
  "unrouted": [
    {
      "direction": "<string>",
      "email_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from_addr": "<string>",
      "handling_state": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "to_addrs": [
        "<string>"
      ],
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "endpoint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "endpoint_localpart": "<string>",
      "endpoint_plane": "<string>",
      "llm_category": "<string>",
      "llm_summary": "<string>",
      "subject": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Response

200 - application/json

The three actionable triage queues + counts

awaiting_review
object[]
required
counts
object
required
quarantined
object[]
required

Admin-only; empty for a non-admin caller.

unrouted
object[]
required

Admin-only; empty for a non-admin caller.