Skip to main content
POST
/
private-api
/
v1
/
{workspace_id}
/
farms
/
{farm_id}
/
tasks
/
search
Search Task Batches
curl --request POST \
  --url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/tasks/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": {
    "in": [
      "online",
      "offline"
    ]
  },
  "task_name": {
    "in": [
      "online",
      "offline"
    ]
  },
  "actor_type": {
    "eq": "user"
  },
  "created_at": {
    "gte": "2026-04-01T00:00:00Z"
  },
  "page": 4503599627370496,
  "limit": 5000
}
'
{
  "success": true,
  "data": [
    {
      "batch_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "task_name": "miner.log.get",
      "status": "pending",
      "task_count": 10,
      "succeed_count": 8,
      "failed_count": 2,
      "task_params": {},
      "created_by": {
        "type": "user",
        "id": "user_2xGz1234567890",
        "name": "John Doe",
        "avatar": "https://example.com/avatar.png",
        "metadata": {}
      },
      "created_at": "YYYY-MM-DDTHH:MM:SSZ"
    }
  ],
  "pagination": {
    "total": 50,
    "limit": 10,
    "offset": 0,
    "hasNext": true,
    "hasPrevious": false
  },
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.nonce.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Clerk Machine API Key for authentication

Path Parameters

workspace_id
string
required
farm_id
string
required

Body

application/json
status
object

Enum or ID filter operators. Provide at least one operator.

Example:
{ "in": ["online", "offline"] }
task_name
object

Enum or ID filter operators. Provide at least one operator.

Example:
{ "in": ["online", "offline"] }
actor_type
object

Actor type filter. Only eq operator supported; multi-type filtering is not available.

Example:
{ "eq": "user" }
created_at
object

Date filter operators using ISO 8601 UTC strings. Provide at least one operator.

Example:
{ "gte": "2026-04-01T00:00:00Z" }
page
integer
Required range: 1 <= x <= 9007199254740991
limit
integer
Required range: 1 <= x <= 10000

Response

Successfully retrieved task batches

success
boolean
required

Indicates if the request was successful

Example:

true

data
Task Batch Summary · object[]
required

Array of items

pagination
object
required

Pagination metadata

error
null
required

Error object (null on success)

Example:

null