Create an export

curl --request POST \
  --url https://fleet-api.flatpeak.com/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "SETTLEMENT_EVIDENCE",
  "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
  "start_time": "2026-08-01T00:00:00Z",
  "end_time": "2026-09-01T00:00:00Z",
  "format": "JSON"
}
'

{
  "id": "exp_4d8e2f6a0b1c3d5e7f9a1b3c",
  "object": "export",
  "live_mode": true,
  "type": "SETTLEMENT_EVIDENCE",
  "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
  "group_id": null,
  "start_time": "2026-08-01T00:00:00Z",
  "end_time": "2026-09-01T00:00:00Z",
  "format": "JSON",
  "status": "PROCESSING",
  "failure_reason": null,
  "download_url": null,
  "time_expiry": null,
  "time_created": "2026-09-02T09:30:00Z",
  "account_id": "acc_6a5e504c3b98d0d6739b5f72"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

POST

exports

curl --request POST \
  --url https://fleet-api.flatpeak.com/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "SETTLEMENT_EVIDENCE",
  "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
  "start_time": "2026-08-01T00:00:00Z",
  "end_time": "2026-09-01T00:00:00Z",
  "format": "JSON"
}
'

{
  "id": "exp_4d8e2f6a0b1c3d5e7f9a1b3c",
  "object": "export",
  "live_mode": true,
  "type": "SETTLEMENT_EVIDENCE",
  "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
  "group_id": null,
  "start_time": "2026-08-01T00:00:00Z",
  "end_time": "2026-09-01T00:00:00Z",
  "format": "JSON",
  "status": "PROCESSING",
  "failure_reason": null,
  "download_url": null,
  "time_expiry": null,
  "time_created": "2026-09-02T09:30:00Z",
  "account_id": "acc_6a5e504c3b98d0d6739b5f72"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

Authenticate with the bearer_token obtained from the authentication endpoint.

Body

application/json

Export create payload. Provide exactly one of program_id or group_id as scope, and a window of up to 90 days.

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"

start_time

string<date-time>

required

Start of the period to export, in UTC. A commitment is included when its interval starts within the period, and a consent record when its time_occurred falls within it.

Example:

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

end_time

string<date-time>

required

End of the period to export, in UTC. At most 90 days after start_time.

Example:

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

format

enum<string>

required

File format of the download.

Available options:

CSV,

JSON

Example:

"CSV"

program_id

string

Scope the export to a program: rows for the devices enrolled in it, including devices that have since left. Provide exactly one of program_id or group_id.

Example:

"vpr_5c8d1f2a7b3e4d6c9a0f1b2c"

group_id

string

Scope the export to a group. Settlement evidence takes the commitments from VPP events created for the group. Consent records take the devices that are in the group when the export is created. Provide exactly one of program_id or group_id.

Example:

"grp_2f6a9c1d8e3b5a7c4d0e9f1a"

Response

Export response. A new export is PROCESSING.

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

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

Value	Meaning
`PROCESSING`	The file is being built. `export.complete` fires when it is ready
`COMPLETE`	The file is ready at `download_url`
`EXPIRED`	The file was deleted, 24 hours after the export completed. Create the export again
`FAILED`	The file could not be built. See `failure_reason`

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"

Platform

Enroll customers

Dispatch devices

Organize the fleet

Settle and reward

Authorizations

Body

Response