Skip to main content

Get Supervisors by Node ID

Retrieves a list of supervisors associated with a specific node.

Request

GET /v2/admin/supervisor/nodes/{nodeId}

Parameters

NameTypeInDescription
nodeIdstringpathRequired. The ID of the node
pageintegerqueryPage number for pagination (default: 1)
per_pageintegerqueryNumber of results per page (default: 10)

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication

Example

curl --request GET \
--url '\{\{baseUrl\}\}/v2/admin/supervisor/nodes/67a68d4462dd1d00073d0af3?page=1&per_page=10' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJRCI6ImMxYTliZWRhLWIxNGMtNGViNS1iODgwLTExMzAyM2U2ZmMyZCIsImV4cGlyYXRpb24iOjE3NDE2MDQyMjYsIm5vZGVJRCI6IjY3YTY4ZDQ0NjJkZDFkMDAwNzNkMGFmMyIsIm5vZGVJbnRJRCI6MSwibm9kZVBhdGgiOiIxIiwic3VwZXJ2aXNvckVtYWlsIjoidWJlckBhcGV4LmNvbSIsInN1cGVydmlzb3JJRCI6IjY2NWIzNzJmM2E3MmQ3ZDA3OTE1OTZiYSJ9.avb0Tf4nGiLI7ECPJEiTZwY8xXy--f2zKjBM0nvqkqQ'

Response

{
"data": [
{
"id": "665b372f3a72d7d0791596ba",
"name": "Burkayco",
"email": "uber@apex.com",
"created_at": "2023-09-05T19:26:16.294Z"
}
],
"total": 1,
"page": 1,
"per_page": 10
}

Response Fields

FieldTypeDescription
dataarrayList of supervisor objects
data[].idstringUnique identifier for the supervisor
data[].namestringName of the supervisor
data[].emailstringEmail address of the supervisor
data[].created_atstringISO 8601 timestamp of when the supervisor was created
totalintegerTotal number of supervisors matching the query
pageintegerCurrent page number
per_pageintegerNumber of results per page

Status Codes

Status CodeDescription
200Success
401Unauthorized - Invalid or missing authentication token
404Not Found - Node ID does not exist
500Internal Server Error