Skip to main content
GET
/
v1
/
api
/
email
/
activity
List email activity
curl --request GET \
  --url https://api.hq.zone/v1/api/email/activity \
  --header 'Authorization: Bearer <token>'
{
  "rows": [
    {
      "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>"
    }
  ],
  "total": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
state
string | null

Optional attention-state filter (handled / awaiting_review / unrouted).

​
endpoint_id
string<uuid> | null

Optional endpoint filter.

​
limit
integer<int64> | null
​
offset
integer<int64> | null
​
sort
string | null

recent (default, newest first) or oldest.

Response

Inbound + outbound email activity (scoped to the caller)

Activity list response: one page of rows + the total count over the whole (scoped + filtered) set, so the UI can render "page X of Y".

​
rows
object[]
required
​
total
integer<int64>
required