API Reference

List users

GET /api/users

Requires admin or superadmin role.

Operation IDlistUsers

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Query parameters

cursorstring

Pagination cursor from a previous response

limitinteger

Maximum number of results to return

Default: 50
Maximum: 200

sortstring

Column name to sort by (validated per-entity)

orderstring

Sort direction

Default: desc
Allowed values: asc, desc

qstring

Case-insensitive search across name/description fields

rolestring

Filter by role

Allowed values: superadmin, admin, viewer

Success response body

200Paginated list of users

Paginated list of users

Content typeapplication/json

responseobject

4 properties

resultarray<UserSafe>required

Array items

itemobject

7 properties

idinteger

usernamestring

rolestring

Allowed values: superadmin, admin, viewer

totp_verifiedinteger

Allowed values: 0, 1

invite_pendingboolean

created_atstring · date-time

updated_atstring · date-time

nextCursorstring

prevCursorstring

totalinteger

Total number of records matching the current filters

Error responses

403Insufficient permissions

Insufficient permissions

No response content schema is documented.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/users?cursor=YOUR_CURSOR&limit=50&sort=YOUR_SORT&order=desc&q=YOUR_Q&role=superadmin' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/users?cursor=YOUR_CURSOR&limit=50&sort=YOUR_SORT&order=desc&q=YOUR_Q&role=superadmin", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);