Skip to main content
GET
/
private-api
/
v1
/
{workspace_id}
/
agents
List Agents
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
}

Authorizations

x-api-key
string
header
required

Legacy Private API Key for authentication

Path Parameters

workspace_id
string
required

Query Parameters

page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

pageSize
number

Number of items per page (default: 10, max: 10000)

Required range: 1 <= x <= 10000
Example:

10

Response

Successfully retrieved agents

success
boolean
required

Indicates if the request was successful

Example:

true

data
Agent · object[]
required

Array of items

pagination
object
required

Pagination metadata

error
null
required

Error object (null on success)

Example:

null