List Batch jobs

GET/v1/batch-jobs

Lists accessible jobs in durable queue order, followed by terminal history.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
None.
Query parameters
NameLocationTypeRequiredDescription
statusquerystringNoA status or comma-separated statuses.
projectIdquerystringNo
ticketIdquerystringNo
limitqueryintegerNo
cursorquerystringNo

Body schema

This endpoint does not require a request body.

None.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Accessible Batch jobsapplication/json
FieldTypeRequiredDescription
objectlistYes
dataobject[]Yes
data[].idstringYesUnique identifier.
data[].userIdstringYesUser ID.
data[].organizationIdstringNo
data[].createdByUserIdstringNo
data[].namestringYesHuman-readable name.
data[].descriptionstringYesHuman-readable description.
data[].targetKindthread_run | metronome_run | evaluation_run | agent_optimization | project_ticket_actionYes
data[].targetResourceIdstringNo
data[].targetVersionIdstringNo
data[].definitionobjectYesNative target definition. A Thread Batch may reference an existing thread with threadId (or targetResourceId), or create a new thread when released by providing message and optional agentId, environmentId/computerId, projectId, title, attachments, skills, reasoning effort, and cost boundaries.
data[].startPolicymanual | stay_on_shelf | when_capacity_availableYesmanual is a one-shot shelf job started explicitly; stay_on_shelf is also started explicitly but returns to the bottom of its shelf after every successful execution; when_capacity_available is automatically released by the scheduler when runtime capacity permits.
data[].statusheld | queued | dispatching | running | succeeded | failed | cancelledYesCurrent lifecycle status.
data[].queueLanestringYes
data[].priorityintegerYes
data[].positionintegerYes
data[].maxAttemptsintegerYes
data[].attemptCountintegerYes
data[].executionGenerationintegerYes
data[].availableAtstringYes
data[].waitReasonstringNo
data[].nativeResourceTypestringNo
data[].nativeResourceIdstringNo
data[].sourceProjectIdstringNo
data[].sourceTicketIdstringNo
data[].permissionSetstringYes
data[].idempotencyKeystringNo
data[].leaseOwnerstringNo
data[].leaseExpiresAtstringNo
data[].heartbeatAtstringNo
data[].lastErrorstringNo
data[].metadataobjectYesFree-form metadata object.
data[].createdAtstringYesISO 8601 timestamp.
data[].updatedAtstringYesISO 8601 timestamp.
data[].queuedAtstringNo
data[].startedAtstringNoISO 8601 timestamp.
data[].completedAtstringNoISO 8601 timestamp.
jobsobject[]Yes
jobs[].idstringYesUnique identifier.
jobs[].userIdstringYesUser ID.
jobs[].organizationIdstringNo
jobs[].createdByUserIdstringNo
jobs[].namestringYesHuman-readable name.
jobs[].descriptionstringYesHuman-readable description.
jobs[].targetKindthread_run | metronome_run | evaluation_run | agent_optimization | project_ticket_actionYes
jobs[].targetResourceIdstringNo
jobs[].targetVersionIdstringNo
jobs[].definitionobjectYesNative target definition. A Thread Batch may reference an existing thread with threadId (or targetResourceId), or create a new thread when released by providing message and optional agentId, environmentId/computerId, projectId, title, attachments, skills, reasoning effort, and cost boundaries.
jobs[].startPolicymanual | stay_on_shelf | when_capacity_availableYesmanual is a one-shot shelf job started explicitly; stay_on_shelf is also started explicitly but returns to the bottom of its shelf after every successful execution; when_capacity_available is automatically released by the scheduler when runtime capacity permits.
jobs[].statusheld | queued | dispatching | running | succeeded | failed | cancelledYesCurrent lifecycle status.
jobs[].queueLanestringYes
jobs[].priorityintegerYes
jobs[].positionintegerYes
jobs[].maxAttemptsintegerYes
jobs[].attemptCountintegerYes
jobs[].executionGenerationintegerYes
jobs[].availableAtstringYes
jobs[].waitReasonstringNo
jobs[].nativeResourceTypestringNo
jobs[].nativeResourceIdstringNo
jobs[].sourceProjectIdstringNo
jobs[].sourceTicketIdstringNo
jobs[].permissionSetstringYes
jobs[].idempotencyKeystringNo
jobs[].leaseOwnerstringNo
jobs[].leaseExpiresAtstringNo
jobs[].heartbeatAtstringNo
jobs[].lastErrorstringNo
jobs[].metadataobjectYesFree-form metadata object.
jobs[].createdAtstringYesISO 8601 timestamp.
jobs[].updatedAtstringYesISO 8601 timestamp.
jobs[].queuedAtstringNo
jobs[].startedAtstringNoISO 8601 timestamp.
jobs[].completedAtstringNoISO 8601 timestamp.
hasMorebooleanYes
nextCursorstringNo
List Batch jobs
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow