Skip to main content
GET
/
v1
/
api
/
users
List users
curl --request GET \
  --url https://api.hq.zone/v1/api/users \
  --header 'Authorization: Bearer <token>'
{
  "messages": [
    {
      "body_markdown": "<string>",
      "delivered_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_kind": "<string>",
      "title": "<string>",
      "ui_strings": "<unknown>",
      "read_at": "2023-11-07T05:31:56Z",
      "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schedule_name": "<string>"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total": 123,
  "unread_count": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
string | null

Case-insensitive substring over real name / handle / email / external id.

​
page
integer<int64> | null

1-based page index (clamped to >= 1).

​
page_size
integer<int64> | null

Rows per page (clamped 1..=200, default 50).

​
status
string | null

active (default, not erased), deleted (erased only), or all.

Response

Workspace user directory

​
messages
object[]
required
​
page
integer<int64>
required
​
page_size
integer<int64>
required
​
total
integer<int64>
required

Total rows matching the unread + search filter, before paging.

​
unread_count
integer<int64>
required

Unread across the whole inbox (drives the nav badge) - independent of the current page / search / sort.