Skip to main content
GET
/
v1
/
api
/
email
/
badge
Get email badge count
curl --request GET \
  --url https://api.hq.zone/v1/api/email/badge \
  --header 'Authorization: Bearer <token>'
{
  "awaiting_review": 123,
  "count": 123,
  "quarantined": 123,
  "unrouted": 123
}

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

Nav-badge count of items needing a human

awaiting_review
integer<int64>
required
count
integer<int64>
required

Sum of the three queues the caller can see (the nav-badge number).

quarantined
integer<int64>
required
unrouted
integer<int64>
required