BRP Connect APIKunden
List customers
List customers assigned to the authenticated BRP. Required scope: customers:read
X-Api-Key<token>
In: header
Query Parameters
status?string
Filter by customer status
Value in
"pending" | "active" | "deactivated"search?string
Free-text search on name or metadata values
limit?integer
Maximum number of items per page
Default
10Range
1 <= value <= 100after?string
Cursor for the next page — pass the next_cursor value from the previous response
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.team/errors/validation",
"title": "Validation Failed",
"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.team/errors/invalid_api_key",
"title": "Invalid API Key",
"status": 401
}{
"type": "https://brp.otark.team/errors/insufficient_scopes",
"title": "Insufficient API Key Scopes",
"status": 403,
"detail": "Missing scope: customers:write. Please create a new API key with the required scopes."
}Bulk get nominations (POST) POST
Retrieve multiple nominations by ID using a request body. Use this for large ID sets that exceed the GET query parameter limit. Non-existent or inaccessible IDs are silently omitted. Required scope: nominations:read
Get customer GET
Retrieve a single customer by ID. Required scope: customers:read