cURL
curl --request GET \ --url https://api.nonce.app/private-api/v1/{workspace_id}/agents \ --header 'x-api-key: <api-key>'
{ "success": true, "data": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "farm_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "farm": { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "Farm Name" }, "workspace_id": "org_xxxxxxxxxxxxxxxxxxxxxxxxxxx", "status": "online/offline", "last_updated_at": "2025-08-27T00:00:00Z", "last_online_at": "<string>", "version": "v0.4.9-1-fdb7d5f", "uptime": 6235631, "host": { "platform": "Darwin", "os": "macOS-15.6-arm64-arm-64bit", "cpu_count": 12, "uptime": 6235631, "timestamp": 1761292878, "load_average": [ 2.0478515625, 2.177734375, 2.046875 ], "memory": { "total": 34359738368, "free": 64126976, "used": 14793719808, "swap_total": 2147483648, "swap_free": 1095696384, "swap_used": 1051787264 }, "ip": "192.168.9.109", "hostname": "localhost" } } ], "pagination": { "total": 50, "limit": 10, "offset": 0, "hasNext": true, "hasPrevious": false }, "error": null }
Returns agents associated with the workspace
Legacy Private API Key for authentication
Page number (default: 1)
x >= 1
1
Number of items per page (default: 10, max: 10000)
1 <= x <= 10000
10
Successfully retrieved agents
Indicates if the request was successful
true
Array of items
Show child attributes
Pagination metadata
Error object (null on success)
null