Batches

Get a defined batch

Returns one defined batch.

get/v2/batches/{batchId}

Request

  • Base URL: https://app.aiva.works (the document declares no server; this is the origin it was published from)
  • URL: https://app.aiva.works/v2/batches/{batchId}
  • Auth: API key in header X-API-KEY

Path parameters

batchIdstring guid required

ID of the batch.

Response

The defined batch

idstring guid required
namestring required
labelsstring[]
scheduleType'Manual' | 'Recurring'
isEnabledboolean
createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.