Skip to main content

List Supervisors

Lists the supervisors of one node, newest first, with pagination. The node is a required query filter; it must be your own node or below it.

Required permission: supervisor:view

Request​

GET /v2/admin/supervisors

Parameters​

NameTypeInDescription
node_idstringqueryRequired. The node whose supervisors are listed (24-character hex id)
namestringqueryCase-insensitive partial match on the supervisor's name or surname
pageintegerqueryRequired. Page number, starting at 1
per_pageintegerqueryRequired. Items per page, 1–100

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/admin/supervisors?node_id=665ae536a6392b75cfd40352&page=1&per_page=10' \
--header 'Authorization: Bearer <access_token>'

Response​

{
"data": [
{
"id": "665b372f3a72d7d0791596ba",
"name": "Jane",
"surname": "Doe",
"profile_photo": null,
"email": "admin@example.com",
"node_id": "665ae536a6392b75cfd40352",
"role_id": "665ae79610ce216dbc35c93b",
"identity_number": "",
"created_at": "2025-09-05T19:26:16.294Z",
"updated_at": "2026-10-01T08:00:12.1Z",
"last_seen_date": "2026-11-08T17:42:03.9Z"
}
],
"total": 1,
"page": 1,
"per_page": 10
}

Response Fields​

FieldTypeDescription
dataarrayThe supervisors
data[].idstringSupervisor id
data[].namestringFirst name. Empty when not set
data[].surnamestringLast name. Empty when not set
data[].profile_photostring | nullProfile photo URL
data[].emailstringEmail address
data[].node_idstringThe node the supervisor belongs to
data[].role_idstringThe supervisor's role
data[].identity_numberstringIdentity number. Empty when not set
data[].created_atstringCreation time (ISO 8601)
data[].updated_atstringLast update time (ISO 8601)
data[].last_seen_datestringLast time the supervisor was seen (ISO 8601)
totalintegerNumber of supervisors matching the filters
pageintegerPage number
per_pageintegerItems per page

Errors​

StatusCodeDescription
40010015Validation failed (missing or malformed node_id, missing page or per_page) — see details
40010001Node not found (node domain 2)
40310005The node is outside your part of the hierarchy (node domain 2)

See Errors for the error format and common codes.