Skip to content
BatteryPass Docs
Portal
Get startedGuidesRecipesIntegrationsAPI referenceChangelog
Passports

The BatteryPass v2.0 export of a version (all tiers)

Scope: readSee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/batteries/{batteryId}/passport/versions/{versionNo}/batterypass-v2

Any member. The stored export, including restricted data; sent as an attachment. Its schema report is in getPassportVersion (advisory, ADR-012).

Authorization

apiKey
headerAuthorizationBearer <token>

Organisation API key sent as Authorization: Bearer bp_live_… (ADR-017). Accepted only by the operations that list this scheme, with the scope in their x-api-key-scope.

Path Parameters

batteryId*string
Formatuuid
versionNo*integer
Range1 <= value

Response Body

The export.

application/json
  1. response

A JSON document whose shape is described elsewhere (snapshot, BatteryPass v2.0 export).

[key: string]?any
Example Request
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/passport/versions/1/batterypass-v2'
Example Response
{}

The evidence library, newest first GET

Any member. Superseded revisions are left out unless `include_superseded=true`.

A PDF of a version with every tier, restricted rows tagged, the signature and the QR code GET

Any member.