GEgetcargo
Orchestration - Batches

List batches

List all orchestration batches

get/orchestration/batches/list

Request

  • Base URL
    https://api.getcargo.io/v1
  • URL
    https://api.getcargo.io/v1/orchestration/batches/list
  • Auth
    HTTP bearer

Query parameters

uuidsstring[]

Batch identifiers to include.

workflowUuidsstring[]

Workflow identifiers to include.

userUuidstring uuid

User identifier to filter by.

releaseUuidstring uuid

Release identifier to filter by.

parentBatchUuidstring uuid

Parent batch identifier.

parentRunUuidstring uuid

Parent run identifier.

parentNodeUuidstring uuid

Parent node identifier.

statusesstring[]

Batch statuses to include.

hasRuns'true' | 'false'

Filter batches that have runs.

isSkipped'true' | 'false'

Filter batches by skipped state.

isFinished'true' | 'false'

Filter batches by finished state.

includedDataKindsstring[]

Data kinds to include.

excludedDataKindsstring[]

Data kinds to exclude.

limitstring

Maximum number of batches to return.

offsetstring

Number of batches to skip.

Response

Successful response

Changes

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