Skip to content
Passports

The published versions of a unit's passport, newest first

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

Any member. With at, only versions published at or before that instant: the first item is the version that was valid then (history by date for the portal, with every tier).

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

Query Parameters

limit?integer

Maximum number of items to return.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from a previous page's next_cursor.

Length1 <= length <= 512
at?string
Formatdate-time

Response Body

A page of versions.

application/json
  1. response
items*array<>
next_cursor*|

Cursor for the next page, or null when this is the last page.

Example Request
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/passport/versions'
Example Response
{  "items": [    {      "batterypass_v2_issue_count": 0,      "batterypass_v2_valid": true,      "canonical_hash": "string",      "key_id": "string",      "public_hash": "string",      "published_at": "2019-08-24T14:15:22Z",      "published_by": "9ac9eee7-2153-423d-b22d-04e12679154a",      "published_by_name": "string",      "reason": "string",      "registry_version": "string",      "valid_until": "2019-08-24T14:15:22Z",      "version_no": 1    }  ],  "next_cursor": "string"}