Skip to main content
POST
Search Task Batches

Authorizations

Authorization
string
header
required

Clerk OAuth JWT access token

Path Parameters

workspace_id
string
required
farm_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
status
object

Aggregate batch status filter

task_name
object

Task name filter

actor_type
object

Creator type filter

created_at
object

Exclusive creation time bounds

page
integer
default:1
Required range: x <= 9007199254740991
page_size
integer
default:20
Required range: x <= 10000

Response

Task batches matching the search criteria

success
enum<boolean>
required
Available options:
true
data
TaskBatchSummary · object[]
required
pagination
object
required
error
null
required
Example:

null