curl --request GET \
--url https://api.hq.zone/v1/api/users \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/api/users"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/api/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hq.zone/v1/api/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/api/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hq.zone/v1/api/users")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/api/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"page": 123,
"page_size": 123,
"total": 123,
"users": [
{
"admin_access": "<string>",
"external_user_id": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_admin": true,
"is_bot": true,
"is_deleted": true,
"is_guest": true,
"origin": "<string>",
"profile_consent": "<string>",
"signin_access": "<string>",
"source_kind": "<string>",
"display_name": "<string>",
"email": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"locale": "<string>",
"real_name": "<string>",
"source_workspace": "<string>",
"title": "<string>",
"tz": "<string>"
}
]
}List users
Returns the workspace’s user directory as a paginated list, each entry including external id, source connector and workspace, display and real name, email, title, timezone, locale, admin/bot/guest/deleted flags, profile-consent state, last-seen time, sign-in access, admin-role override, and origin (slack, teams, or email). Supports a case-insensitive q search over name/handle/email/id, page and page_size pagination (page_size clamped 1-200, default 50), and a status filter of active (default), deleted, or all. Admin only; bots are excluded and results are scoped to the caller’s own workspace.
curl --request GET \
--url https://api.hq.zone/v1/api/users \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/api/users"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/api/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hq.zone/v1/api/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/api/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hq.zone/v1/api/users")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/api/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"page": 123,
"page_size": 123,
"total": 123,
"users": [
{
"admin_access": "<string>",
"external_user_id": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_admin": true,
"is_bot": true,
"is_deleted": true,
"is_guest": true,
"origin": "<string>",
"profile_consent": "<string>",
"signin_access": "<string>",
"source_kind": "<string>",
"display_name": "<string>",
"email": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"locale": "<string>",
"real_name": "<string>",
"source_workspace": "<string>",
"title": "<string>",
"tz": "<string>"
}
]
}Authorizations
Personal Access Token. Send as Authorization: Bearer hq_pat_....
Query Parameters
Case-insensitive substring over real name / handle / email / external id.
1-based page index (clamped to >= 1).
Rows per page (clamped 1..=200, default 50).
active (default, not erased), deleted (erased only), or all.