Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
bulk-uploads

Read a bulk-upload job

GET
/v1/bulk-uploads/{id}
curl --request GET \
  --url https://aggregator.example.com/v1/bulk-uploads/example \
  --header 'Authorization: Bearer <token>'

Returns the full job row including status, per-row counters, and error summary.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters

Bulk-upload job id (UUID).

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
upload_id
required
string
status
required
string
status_reason
required
string
nullable
participant_type
required
string
total_rows
required
number
nullable
passed
required
number
failed
required
number
skipped
required
number
errors_csv_s3_key
required
string
nullable
schema_id
required
string
schema_version
required
string
created_at
required
string
completed_at
required
string
nullable
key
additional properties
any
Examplegenerated
{
  "upload_id": "example",
  "status": "example",
  "status_reason": "example",
  "participant_type": "example",
  "total_rows": 1,
  "passed": 1,
  "failed": 1,
  "skipped": 1,
  "errors_csv_s3_key": "example",
  "schema_id": "example",
  "schema_version": "example",
  "created_at": "example",
  "completed_at": "example"
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

503

Section titled “503”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}