Skip to main content
The Partner API allows you to access customer data stored in the RABOT platform. Depending on the partnership scope and agreed data privacy policies, your API client will have a certain access scope assigned (see Scopes), which control the visibility of customer and contract information.

​
Sales Affilliate partners

For a sales partnership, you should use the /orders endpoints to track processing of orders instead of the /customers endpoints. See Check order status.

​
3rd Party [E.g. HEMS] Integration partners

If your application is enabling customers of RABOT Energy or RABOT Whitelabel partners to link their accounts to your application and to allow your application to access their data on the RABOT platform, the /customers endpoints will only list those customers that successfully approved the data access through the customer linking process.

​
Whitelabel partners

As a whitelabel partner, you will automatically see all customers in the API that you have acquired and that successfully ordered an energy supply contract, either through the web funnel or the API (see create new order endpoint). For your customers, you will have access according to the partnership agreement - either role:finance-reporting, role:customer-support or role:application scope. If you don’t have the role:application scope by default, you can use the customer linking process to request opt-in from customers, granting full data access to your application.

​
Delivery Stage

Once an order has successfully cleared the change process, the contract will be in a PendingDelivery state until the start of delivery. This start delivery date is available in the orders DTO in the field actualDateOfDelivery once we have received the communication from the DSO.
At this state, you will see the customer returned in the GET /customers endpoint response as they transition to Customer status.
As delivery begins, the data retrievable via the /contracts endpoint and the relevant subpaths will populate as per the customer’s delivery location setup, e.g. Actual Consumption values (if TAF7 enabled). Please refer to our Contract Data, Documents & Metrics for more information.

​
Customer List

You can get a list of all customers visible to your application, according to the restrictions above using the list customers endpoint. See paging to learn how to work with large data sets.
example request
curl -L "https://api.rabot-charge.de/partner/v1/customers?limit=75&offset=0" \
-H "Authorization: ••••••"
example response
{
    "count": 3,
    "hasMoreItems": false,
    "data": [
        {
            "customerNumber": "41219866",
            "externalIdentifier": null,
            "firstName": "Carla",
            "lastName": "Ertl",
            "businessName": null,
            "emailAddress": "[email protected]",
            "relations": [
                "Owner"
            ]
        },
        {
            "customerNumber": "74048277",
            "externalIdentifier": null,
            "firstName": "Max",
            "lastName": "Mustermann",
            "businessName": null,
            "emailAddress": "[email protected]",
            "relations": [
                "Owner"
            ]
        },
        {
            "customerNumber": "46491184",
            "externalIdentifier": "test-1",
            "firstName": "Alexa",
            "lastName": "Weigel",
            "businessName": null,
            "emailAddress": "[email protected]",
            "relations": [
                "Owner",
                "Linked"
            ]
        }
    ],
    "isSuccess": true,
    "message": null,
    "error": null
}
The relations attributes in the customer records help you to understand the relationship and access level you have for the respective customer:
RelationDescription
AffiliateA customer acquired by you in a Sales Partnership model
OwnerA customer acquired by you in a Whitelabel Partnership model
LinkedA customer that has granted you full data access through the customer linking process

​
Creating new customers

New customers cannot be created directly via the API. Instead, customers will be created automatically when they submit an order via the web funnel, or when you submit new customer details via the create new order call.