Skip to main content
GET
Retrieve an export

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

export_id
string
required

Flatpeak Export ID.

Response

Export response.

An asynchronous export. See type for what each packages. The file can be downloaded for 24 hours after the export completes.

id
string
required

Flatpeak Export ID.

Example:

"exp_4d8e2f6a0b1c3d5e7f9a1b3c"

object
enum<string>
required

Object type, export.

Available options:
export
Example:

"export"

live_mode
boolean
required

true for live data, false for test data.

Example:

true

type
enum<string>
required

SETTLEMENT_EVIDENCE: one row per commitment, with the device meter records behind each delivery. CONSENT_RECORDS: one row per consent grant or revocation.

Available options:
SETTLEMENT_EVIDENCE,
CONSENT_RECORDS
Example:

"SETTLEMENT_EVIDENCE"

program_id
string | null
required

The program the export is scoped to. null when it is scoped to a group.

Example:

"vpr_5c8d1f2a7b3e4d6c9a0f1b2c"

group_id
string | null
required

The group the export is scoped to. null when it is scoped to a program.

Example:

null

start_time
string<date-time>
required

Start of the exported period, in UTC.

Example:

"2026-08-01T00:00:00Z"

end_time
string<date-time>
required

End of the exported period, in UTC.

Example:

"2026-09-01T00:00:00Z"

format
enum<string>
required

File format of the download.

Available options:
CSV,
JSON
Example:

"CSV"

status
enum<string>
required
Available options:
PROCESSING,
COMPLETE,
EXPIRED,
FAILED
Example:

"COMPLETE"

failure_reason
string | null
required
read-only

Why the export failed. null unless status is FAILED. Recreate the export to retry.

Example:

null

download_url
string | null
required
read-only

Download URL of the file. Set while status is COMPLETE, and valid until time_expiry; null in every other status.

time_expiry
string<date-time> | null
required
read-only

Time when download_url stops working and the file is deleted, in UTC: 24 hours after the export completed. null until status is COMPLETE.

Example:

"2026-09-03T09:34:10Z"

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-08-12T09:30:00Z"

account_id
string
required

Flatpeak Account ID of the operator that owns the export.

Example:

"acc_649d465ede6a785d2fa5f905"