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 'Authorization: Bearer <token>'
import requests

url = "https://api.nonce.app/private-api/v1/{workspace_id}/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nonce.app/private-api/v1/{workspace_id}/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nonce.app/private-api/v1/{workspace_id}/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.nonce.app/private-api/v1/{workspace_id}/agents"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.nonce.app/private-api/v1/{workspace_id}/agents")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.nonce.app/private-api/v1/{workspace_id}/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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
}
{
"statusCode": 400,
"message": "Invalid request parameters",
"error": "Bad Request"
}
{
"statusCode": 401,
"message": "Invalid or missing API key",
"error": "Unauthorized"
}
{
"statusCode": 403,
"message": "Access denied to workspace",
"error": "Forbidden"
}

Authorizations

Authorization
string
header
required

Clerk Machine 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