Skip to main content
GET
/
v1
/
api
/
email
/
endpoints
List email endpoints
curl --request GET \
  --url https://api.hq.zone/v1/api/email/endpoints \
  --header 'Authorization: Bearer <token>'
{
  "endpoints": [
    {
      "allow_escalation": true,
      "allow_patterns": [
        "<string>"
      ],
      "awaiting_review": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "escalated": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_system": true,
      "kind": "<string>",
      "localpart": "<string>",
      "message_count": 123,
      "needs_attention": 123,
      "plane": "<string>",
      "received": 123,
      "replied": 123,
      "reply_languages": "<unknown>",
      "reply_policy": "<string>",
      "sender_policy": "<string>",
      "unrouted": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_policy": "<unknown>",
      "default_reply_lang": "<string>",
      "deliver_to": "<unknown>",
      "instructions": "<string>",
      "last_occurred_at": "2023-11-07T05:31:56Z",
      "max_turns_per_day": 123,
      "max_turns_per_sender_day": 123,
      "spam_score_max": 123
    }
  ],
  "outbound_mailbox_localpart": "<string>",
  "domain": "<string>",
  "tenant_email_slug": "<string>"
}

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

Inbound email endpoints + counters

endpoints
object[]
required
outbound_mailbox_localpart
string
required

The localpart of the workspace outbound mailbox (default 'team'); the full address is <localpart>-<tenant_email_slug>@<domain>.

domain
string | null
tenant_email_slug
string | null

The tenant's canonical email slug + domain so the UI can preview the full <localpart>-<slug>@<domain> address without another call.