List batches

List all orchestration batches

GET /orchestration/batches/list

List batches

cURL

curl --request GET \
  --url https://api.getcargo.io/v1/orchestration/batches/list \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getcargo.io/v1/orchestration/batches/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getcargo.io/v1/orchestration/batches/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcargo.io/v1/orchestration/batches/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcargo.io/v1/orchestration/batches/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getcargo.io/v1/orchestration/batches/list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/batches/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "batches": [
    {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "workflowUuid": "<string>",
      "userUuid": "<string>",
      "releaseUuid": "<string>",
      "nodes": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "config": {},
          "childrenUuids": [
            "<string>"
          ],
          "fallbackOnFailure": true,
          "position": {
            "x": 123,
            "y": 123
          },
          "kind": "native",
          "actionSlug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "retry": {
            "maximumAttempts": 123,
            "initialInterval": 123,
            "backoffCoefficient": 123
          },
          "fallbackChildUuid": "<string>"
        }
      ],
      "temporalWorkflowId": "<string>",
      "traceUuid": "<string>",
      "data": {
        "kind": "<string>",
        "segmentUuid": "<string>"
      },
      "errorMessage": "<string>",
      "runsCount": 123,
      "executedRunsCount": 123,
      "failedRunsCount": 123,
      "creditsUsedCount": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "finishedAt": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

uuids · string[]

Batch identifiers to include.

workflowUuids · string[]

Workflow identifiers to include.

userUuid · string<uuid>

User identifier to filter by.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

releaseUuid · string<uuid>

Release identifier to filter by.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

parentBatchUuid · string<uuid>

Parent batch identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

parentRunUuid · string<uuid>

Parent run identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

parentNodeUuid · string<uuid>

Parent node identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

statuses · enum<string>[]

Batch statuses to include.

Available options: pending, syncing, skipped, querying, running, success, error, cancelling, cancelled

hasRuns · enum<string>

Filter batches that have runs.

Available options: true, false

isSkipped · enum<string>

Filter batches by skipped state.

Available options: true, false

isFinished · enum<string>

Filter batches by finished state.

Available options: true, false

includedDataKinds · enum<string>[]

Data kinds to include.

Available options: segment, change, filter, recordIds, records, file, runs, group, schedule, form

excludedDataKinds · enum<string>[]

Data kinds to exclude.

Available options: segment, change, filter, recordIds, records, file, runs, group, schedule, form

limit · string

Maximum number of batches to return.

offset · string

Number of batches to skip.

Response

200

application/json

Successful response

batches · Batches · object[] · required

List of batches.

Show child attributes