Skip to main content
GET
/
private-api
/
v1
/
{workspace_id}
/
farms
List Farms
curl --request GET \
  --url https://api.nonce.app/private-api/v1/{workspace_id}/farms \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Farm Name",
      "workspace_id": "org_xxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  ],
  "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 farms

success
boolean
required

Indicates if the request was successful

Example:

true

data
Farm · object[]
required

Array of items

pagination
object
required

Pagination metadata

error
null
required

Error object (null on success)

Example:

null