BRP Connect API
GET /v1/customers
Die Kunden auflisten, die dem angemeldeten BKV zugeordnet sind. Erforderlicher Scope: customers:read
X-Api-Key<token>
In: header
Query Parameters
status?string
Nach Kundenstatus filtern
Value in
"pending" | "active" | "deactivated"search?string
Freitextsuche über Namen und Metadatenwerte
limit?integer
Höchstzahl der Einträge pro Seite
Default
10Range
1 <= value <= 100after?string
Cursor für die nächste Seite — den Wert next_cursor aus der vorherigen Antwort übergeben
Response Body
curl -X GET "https://api.otark.energy/v1/customers?status=pending&search=string&limit=10&after=con_a1b2c3d4"{
"customers": [
{
"id": "cust_r8s9t0u1",
"name": "SolarDach GmbH",
"status": "active",
"balance_group": {
"eic": "11YSOLARDACH--A",
"tso": "DE_AMPRION"
},
"metadata": {
"customer_number": "KD-2026-0815",
"cost_center": "CC-4200",
"region": "NRW"
},
"assigned_at": "2026-01-10T09:00:00Z",
"activated_at": "2026-01-10T11:30:00Z",
"created_at": "2026-01-10T09:00:00Z"
}
],
"pagination": {
"limit": 10,
"has_more": true,
"next_cursor": "txn_k8m2p4q7r1"
}
}{
"type": "https://brp.otark.energy/errors/validation",
"title": "Validierung fehlgeschlagen",
"status": 400,
"instance": "/v1/customers/cust_r8s9t0u1",
"errors": [
{
"field": "balance_group.tso",
"code": "invalid_enum_value",
"message": "Invalid enum value. Expected 'DE_AMPRION' | 'DE_TENNET' | 'DE_TRANSNET_BW' | 'DE_50HERTZ', received 'INVALID'"
}
]
}{
"type": "https://brp.otark.energy/errors/invalid_api_key",
"title": "Ungültiger API-Schlüssel",
"status": 401
}{
"type": "https://brp.otark.energy/errors/insufficient_scopes",
"title": "Unzureichende Scopes des API-Schlüssels",
"status": 403,
"detail": "Missing scope: customers:write. Please create a new API key with the required scopes."
}/nominations/bulk POST
Mehrere Nominierungen über ihre Kennungen im Anfrage-Body abrufen. Dieser Weg ist für große Kennungsmengen gedacht, die über das Limit des GET-Query-Parameters hinausgehen. Kennungen, die nicht existieren oder nicht zugänglich sind, werden stillschweigend übergangen. Erforderlicher Scope: nominations:read
/customers/{customer_id} GET
Einen einzelnen Kunden über seine Kennung abrufen. Erforderlicher Scope: customers:read