Skip to main content
GET
Get bulk download job status

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

bulkDownloadId
string<uuid>
required

Response

Job status, progress, and download URL when complete

id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
processing,
done,
failed
totalFiles
integer
required
completedFiles
integer
required
createdOn
string<date-time>
completedOn
string<date-time> | null
errorMessage
string | null
downloadUrl
string | null

Presigned S3 url. Available when status=done