GET
/
api
/
batches
List Batch Jobs
curl --request GET \
  --url https://api.embedreach.com/api/batches
{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "batchId": "<string>",
        "status": "success",
        "batchType": "PARTNER_RESOURCE_JSON_INGEST",
        "progress": {
          "totalRecords": 123,
          "processedRecords": 123,
          "successfulRecords": 123,
          "failedRecords": 123,
          "successRate": 123
        },
        "completedAt": "<string>",
        "errors": {
          "summary": {},
          "details": {},
          "message": "<string>"
        }
      }
    ],
    "pagination": {
      "total": 123,
      "hasNextPage": true,
      "cursor": "<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)

Response

200
application/json

Status 200 response

The response is of type object.