Skip to main content
GET
Retrieves a ReportExportJob resource.

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

uuid
string
required

ReportExportJob identifier

Response

ReportExportJob resource

One asynchronous download run of a {@see ReportDefinition}. Modeled on {@see Import}: carries progress (totalRows/processedRows) so the frontend can render a live progress popup (via Mercure push or polling this record), and the S3 object name of the finished file for presigned download-link regeneration.

uuid
string
read-only
reportName
string | null
status
string
default:pending
totalRows
integer | null
default:0
processedRows
integer | null
default:0
errorSummary
string | null
dateCreated
string<date-time>
read-only
dateCompleted
string<date-time> | null
progressPercentage
number
read-only