API Reference
Core Resources
- Entities
- Collectives
- Tenants
Onboarding API
- Entity Onboarding
- Collective Onboarding
- Guided Onboarding
Readings API
- Readings
- Aggregations
Commands API
Charge Sessions API
Entity Settings
- Features
- Locations
- Battery Capacity
- Heated Area
- Disaggregators
- Custom Properties
Offboarding API
- Offboard Entities
List all Entity Onboarding Requests
Returns a page of Entity Onboarding Requests for a specific manufacturer and type, optionally with additional filters.
curl --request GET \
--url https://platform.realto.io/api/v1/onboarding/entities \
--header 'Authorization: Bearer <token>'{
"data": [
{
"action": {
"documentationLink": "<string>",
"redirectLink": "<string>",
"type": "Consent"
},
"data": {
"collective": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Community"
},
"entity": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"information": {
"code": "<string>",
"ean": "<string>",
"email": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"reference": "<string>",
"track": "<string>",
"type": "Battery",
"uuid": "<string>",
"vin": "<string>"
},
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"reference": {
"manufacturer": "<string>",
"type": "<string>",
"reference": "<string>"
},
"systemProperties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Battery"
},
"tenant": {
"type": "Company",
"administrator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"user": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"givenName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"surname": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isTenantAdmin": true
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}
],
"links": {
"next": "<string>"
},
"meta": {
"continuationToken": "<string>",
"pageSize": 123
}
}Authorizations
Access Token Authentication
Query Parameters
The manufacturer to filter on
The type to filter on
Battery, Boiler, ChargePole, EV, HeatPump, PV, RetrofitMeter, SmartMeter The VIN to filter on
The status to filter on
Canceled, Failed, InProgress, Pending, Succeeded The action to filter on
Connect, CreateCollective, CreateEntity, CreatePermissions, CreateTenant, CreateUser, RefreshConnection, CreateClient The number of Entity Onboarding Requests per page
The token used to retrieve the next page
Response
A page of onboarding requests
Represents the data of an onboarding request
Represents data required to onboard a Collective
The id of the Collective
The name of the Collective
The owner of the Collective
The custom properties of the Collective
The id of the Tenant of the Collective
Community, Household, Fleet, SolarFarm, WindFarm Represents data required to onboard an Entity
The id of the Collective the Entity belongs to.
The id of the Entity
Represents information about an Entity
The code of an Entity
The EAN number of an Entity
The email address used for onboarding an Entity
The manufacturer of an Entity
The model of an Entity
The reference of an Entity
The track for an Entity
Battery, Boiler, ChargePole, EV, HeatPump, PV, RetrofitMeter, SmartMeter The unique identifier of an Entity
The Vehicle Identification Number of an Entity
The id of the owner of the Entity
The custom properties of the Entity
The system properties of the Entity
The id of the Tenant the Entity belongs to
Battery, Boiler, ChargePole, EV, HeatPump, PV, RetrofitMeter, SmartMeter Represents data required to onboard a User
The id of the Collective the User belongs to
The email address of the User
The given name of the User
The id of the User
The language of the User
The surname of the User
The id of the Tenant the User belongs to
Represents data required to onboard a Client
The id of the Client
The name of the Client
The id of the Tenant the Client belongs to
The id of the Client's Owner
Indicates whether the Client is a tenant admin
The id of the onboarding request
The id of the principal that initiated the onboarding request
Collective, Entity, Tenant, User, Client The url where the User will be redirected to after completing the consent flow on the OEM page.
Canceled, Failed, InProgress, Pending, Succeeded Was this page helpful?
curl --request GET \
--url https://platform.realto.io/api/v1/onboarding/entities \
--header 'Authorization: Bearer <token>'{
"data": [
{
"action": {
"documentationLink": "<string>",
"redirectLink": "<string>",
"type": "Consent"
},
"data": {
"collective": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Community"
},
"entity": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"information": {
"code": "<string>",
"ean": "<string>",
"email": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"reference": "<string>",
"track": "<string>",
"type": "Battery",
"uuid": "<string>",
"vin": "<string>"
},
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"reference": {
"manufacturer": "<string>",
"type": "<string>",
"reference": "<string>"
},
"systemProperties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Battery"
},
"tenant": {
"type": "Company",
"administrator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"user": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"givenName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"surname": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isTenantAdmin": true
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}
],
"links": {
"next": "<string>"
},
"meta": {
"continuationToken": "<string>",
"pageSize": 123
}
}