List Batch Jobs

Retrieves all batch jobs for a business with pagination.

GET /api/batches

List Batch Jobs

cURL

curl --request GET \
  --url https://api.embedreach.com/api/batches

import requests

url = "https://api.embedreach.com/api/batches"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.embedreach.com/api/batches', 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.embedreach.com/api/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.embedreach.com/api/batches"

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

	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.embedreach.com/api/batches")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/batches")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "batchId": "<string>",
        "progress": {
          "totalRecords": 123,
          "processedRecords": 123,
          "successfulRecords": 123,
          "pendingRecords": 123,
          "failedRecords": 123,
          "successRate": 123
        },
        "completedAt": "<string>",
        "startedAt": "<string>",
        "createdAt": "<string>",
        "schemaName": "<string>",
        "schemaDefinitionId": "<string>",
        "errors": {
          "summary": {},
          "details": {},
          "message": "<string>"
        },
        "pendingResources": [
          {
            "id": "<string>",
            "resourceExternalId": "<string>",
            "schemaDefinitionId": "<string>",
            "missingDependencies": [
              {
                "schemaDefinitionId": "<string>",
                "externalId": "<string>",
                "schemaName": "<string>"
              }
            ],
            "expiresAt": "<string>",
            "createdAt": "<string>",
            "schemaName": "<string>"
          }
        ]
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "cursor": "<string>",
      "total": 123
    }
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

Headers

reach-tenant-id · string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

cursor · string

Pagination cursor

limit · string | null

Number of results per page (Default: 20)

batchType · enum<string>

Optional batch type to filter by. If not provided, returns all batch types.

Available options: PARTNER_RESOURCE_JSON_INGEST, PARTNER_RESOURCE_BATCH_DELETE, PARTNER_RESOURCE_BATCH_PATCH

sortBy · enum<string>

Optional field to sort by. Defaults to createdAt.

Available options: createdAt, startedAt, completedAt

sortDirection · enum<string>

Optional sort direction. Defaults to desc.

Available options: asc, desc

includePendingDetails · enum<string>

Whether to include detailed information about pending resources and their dependencies

Available options: true, false

onlyBatchesWithPendingResources · enum<string>

Whether to only return batches that have pending resources (filters by pendingRecords > 0)

Available options: true, false

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes