Skip to main content
GET
/
api
/
batches
/
{batchId}
Get Batch Status
curl --request GET \
  --url https://api.embedreach.com/api/batches/{batchId}
{
  "success": true,
  "message": "<string>",
  "data": {
    "batchId": "<string>",
    "status": "success",
    "batchType": "PARTNER_RESOURCE_JSON_INGEST",
    "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>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.embedreach.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
batchId
string
required

The batch ID to check status for

Query Parameters

​
includePendingDetails
enum<string>

Whether to include detailed information about pending resources and their dependencies

Available options:
true,
false

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object