List users
curl --request GET \
--url https://{host}/api/v3/users \
--header 'X-Qanapi-Authorization: <api-key>'import requests
url = "https://{host}/api/v3/users"
headers = {"X-Qanapi-Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Qanapi-Authorization': '<api-key>'}};
fetch('https://{host}/api/v3/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://{host}/api/v3/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 => [
"X-Qanapi-Authorization: <api-key>"
],
]);
$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://{host}/api/v3/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Qanapi-Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/api/v3/users")
.header("X-Qanapi-Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v3/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Qanapi-Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3f1a8c42-6d9b-4e07-9a55-2b8c1d0e7f31",
"email": "ada@example.com",
"name": "Ada Lovelace",
"role": "admin",
"created_at": "2026-03-14T09:21:07Z",
"updated_at": "2026-09-02T16:48:33Z"
},
{
"id": "b7c4e918-2a5d-4c63-8e10-5f9a3d2b6c84",
"email": "grace@example.com",
"name": "Grace Hopper",
"role": "user",
"created_at": "2026-05-06T11:02:44Z",
"updated_at": "2026-05-06T11:02:44Z"
}
]{
"message": "Unauthorized.",
"error": "Unauthenticated"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Invalid permission to perform action",
"error": "AccessDenied"
}Users
List users
Every account, oldest first. Requires user:manage. Not paginated and
not filtered.
GET
/
api
/
v3
/
users
List users
curl --request GET \
--url https://{host}/api/v3/users \
--header 'X-Qanapi-Authorization: <api-key>'import requests
url = "https://{host}/api/v3/users"
headers = {"X-Qanapi-Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Qanapi-Authorization': '<api-key>'}};
fetch('https://{host}/api/v3/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://{host}/api/v3/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 => [
"X-Qanapi-Authorization: <api-key>"
],
]);
$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://{host}/api/v3/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Qanapi-Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/api/v3/users")
.header("X-Qanapi-Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v3/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Qanapi-Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3f1a8c42-6d9b-4e07-9a55-2b8c1d0e7f31",
"email": "ada@example.com",
"name": "Ada Lovelace",
"role": "admin",
"created_at": "2026-03-14T09:21:07Z",
"updated_at": "2026-09-02T16:48:33Z"
},
{
"id": "b7c4e918-2a5d-4c63-8e10-5f9a3d2b6c84",
"email": "grace@example.com",
"name": "Grace Hopper",
"role": "user",
"created_at": "2026-05-06T11:02:44Z",
"updated_at": "2026-05-06T11:02:44Z"
}
]{
"message": "Unauthorized.",
"error": "Unauthenticated"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Invalid permission to perform action",
"error": "AccessDenied"
}Authorizations
ApiKeyAuthBearerAuth
A machine credential, qk_ followed by its secret. Only a hash of the
secret is stored, so a key is displayed exactly once, when it is created
or rotated. A key reaches only the configurations it is linked to.
It may also be sent as Authorization: Bearer qk_..., which is
recognised by the prefix.
Response
Every user.
admin is the only role that reaches user, policy and API key
management without an explicit policy statement.
Available options:
admin, user ⌘I