Skip to main content
GET
Get batch status

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).

Path Parameters

batchId
string<uuid>
required

Batch ID

Response

Batch status summary

batchId
string<uuid>
required

Batch ID

status
enum<string>
required

Aggregate batch status: running while any run is in flight, failed when any finished run failed, completed when all finished runs passed, cancelled when every run was cancelled

Available options:
queued,
running,
completed,
failed,
cancelled
counts
object
required

Run counts by status

runs
object[]
required

Child runs ordered by creation time