Skip to main content
GET
/
partner
/
v1
/
customers
Get customers accessible by the partner
curl --request GET \
  --url https://api.rabot-charge.de/partner/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "isSuccess": true,
  "message": null,
  "error": [
    {
      "severity": "Error",
      "code": "validation-failed",
      "message": "First name is required for non-business customers.",
      "details": null
    }
  ],
  "refUri": "<string>",
  "data": [
    {
      "customerNumber": "123456789",
      "emailAddress": "[email protected]",
      "externalIdentifier": "123456789",
      "firstName": "Max",
      "lastName": "Mustermann",
      "businessName": "Company GmbH",
      "relations": "Owner"
    }
  ],
  "count": 10,
  "hasMoreItems": true
}
You can retrieve the list of customers using this endpoint, depending on you partner setup and data access levels. See the guide for more information on access levels and customer linking. Use the filter.externalId request parameter to retrieve just the customers with a given externalId. By default, the API returns only the first 10 records. Use offset and limit request parameters for paging.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
offset
integer<int32>
default:0

Offset of the page.

​
limit
integer<int32>
default:10

Size of the page.

​
filter.externalId
string

Optional external identifier for querying by

Response

200 - application/json

OK

API response DTO with a list of items.

​
isSuccess
boolean

Success status of the operation based on status code (2xx range).

Example:

true

​
message
string | null

Optional message to provide additional information about the operation result.

Example:

null

​
error
object[] | null

Optional error details in case of an error(s).

​
refUri
string<uri> | null

Optional reference URI to point to the resulting resource.

​
data
object[]

Returned data instance.

​
count
integer<int32>

Number of items returned in the list.

Example:

10

​
hasMoreItems
boolean

Indicates, whether there are more items to be returned in the list, that are not included in the limit of this request.

Example:

true