Skip to main content
POST
Search Task Batches

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

Aggregate task batch status filter

Example:
task_name
object

Task name filter

Example:
actor_type
object

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

Example:
created_at
object

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

Example:
page
integer

Page number, starting at 1

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

1

limit
integer

Results per page

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

50

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