Skip to main content
GET
/
bulk_requests
/
{id}
Get bulk request status
curl --request GET \
  --url https://api.endclose.com/v1/bulk_requests/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "status": "pending",
  "total_items": 123,
  "processed_items": 123,
  "successful_items": 123,
  "failed_items": 123,
  "progress": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "results": {
    "data": [
      {
        "index": 123,
        "status": "successful",
        "record_id": 123,
        "error": "<string>"
      }
    ],
    "has_more": true,
    "offset": 123
  }
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

The bulk request ID returned from POST /records/bulk

Query Parameters

limit
integer
default:25

Number of result items to return

Required range: 1 <= x <= 100
offset
integer
default:0

Pagination offset for result items

Response

Bulk request status with paginated results

id
integer
status
enum<string>

pending = queued, processing = records being inserted, completed = all rows processed

Available options:
pending,
processing,
completed
total_items
integer

Total number of records submitted

processed_items
integer

Number of records processed so far

successful_items
integer

Number of records successfully created

failed_items
integer

Number of records that failed validation or insertion

progress
integer

Processing progress as a percentage (0-100)

created_at
string<date-time>
completed_at
string<date-time> | null

Set when all items have been processed

results
object