Browse documentation
Batches

Get Batch

get/v1/check_batches/{batch_id}

Get Batch

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

batch_id
path · required

No additional parameter description.

Example request

cURL
curl --request GET \
  --url 'https://api.fideralabs.com/v1/check_batches/{batch_id}' \
  --header 'Authorization: Bearer $FIDERA_API_KEY'

Responses

200Successful Response
completed_at
string | nullrequired

No additional field description.

completed_count
integerrequired

No additional field description.

created_at
stringrequired

No additional field description.

datasets
string[]required

No additional field description.

error
string | nullrequired

No additional field description.

error_count
integerrequired

No additional field description.

id
stringrequired

No additional field description.

records
object[]required

No additional field description.

results
object[]required

No additional field description.

status
BatchStatusrequired

No additional field description.

subject_count
integerrequired

No additional field description.

updated_at
stringrequired

No additional field description.

use_case
CheckUseCaserequired

No additional field description.

application/json
{
  "completed_at": "2026-07-29T12:00:00Z",
  "completed_count": 0,
  "created_at": "2026-07-29T12:00:00Z",
  "datasets": [
    "string"
  ],
  "error": "string",
  "error_count": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "records": [
    {}
  ],
  "results": [
    {}
  ],
  "status": "string",
  "subject_count": 0,
  "updated_at": "2026-07-29T12:00:00Z"
}
422Validation Error
detail
ValidationError[]

No additional field description.

Operation ID

get_batch_v1_check_batches__batch_id__get