Skip to main content
GET
List users

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

page
integer<int64>
required
page_size
integer<int64>
required
total
integer<int64>
required

Total rows matching the (bot-excluded + search) filter, before LIMIT/OFFSET - drives the page control. A workspace can have 1500+ users.

users
object[]
required