Skip to content
BatteryPass Docs
Portal
Get startedGuidesRecipesIntegrationsAPI referenceChangelog
Catalog

A battery model

Scope: readSee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/battery-models/{modelId}

Any member.

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

modelId*string
Formatuuid

Response Body

The battery model.

application/json
  1. response
archived_at*|
Formatdate-time
category*BatteryCategory

Battery category per Regulation (EU) 2023/1542; drives registry requirements.

Value in"ev""lmt""industrial""stationary""industrial_without_bms"
created_at*string
Formatdate-time
gtin*|

GTIN-14 (normalised, check digit valid).

Match^[0-9]{14}$
id*string
Formatuuid
name*string
Length1 <= length <= 120
row_version*RowVersion

Optimistic-concurrency version; send it back as If-Match when updating.

Formatint64
Range1 <= value
sku*|
Lengthlength <= 100
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://example.com/api/v1/battery-models/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "archived_at": "2019-08-24T14:15:22Z",  "category": "ev",  "created_at": "2019-08-24T14:15:22Z",  "gtin": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "row_version": 1,  "sku": "string",  "updated_at": "2019-08-24T14:15:22Z"}

The units as a spreadsheet with the import's columns GET

Any member. The units matching the filters (at most 10 000) with the columns of an import: model, version, the unit's fields and every unit-level field with a value, so the file can be edited and imported again (`docs/architecture.md` §7). XLSX by default.

A unit GET

Any member.