GET
/
v1
/
onboarding
/
entities
curl --request GET \
  --url https://platform.realto.io/api/v1/onboarding/entities \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "action": {
        "documentationLink": "<string>",
        "redirectLink": "<string>",
        "type": "Consent"
      },
      "created": "2023-11-07T05:31:56Z",
      "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": "Household"
        },
        "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",
          "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

​
Authorization
string
header
required

Access Token Authentication

Query Parameters

​
manufacturer
string

The manufacturer to filter on

​
type
enum<string>

The type to filter on

Available options:
Battery,
Boiler,
ChargePole,
EV,
HeatPump,
PV,
RetrofitMeter,
SmartMeter
​
vin
string

The VIN to filter on

​
status
enum<string>

The status to filter on

Available options:
Canceled,
Failed,
InProgress,
Pending,
Succeeded
​
action
enum<string>

The action to filter on

Available options:
Connect,
CreateCollective,
CreateEntity,
CreatePermissions,
CreateTenant,
CreateUser,
RefreshConnection,
CreateClient
​
pageSize
integer
default:25

The number of Entity Onboarding Requests per page

​
continuationToken
string

The token used to retrieve the next page

Response

200
application/json
OK

A page of onboarding requests

​
data
object[] | null

Represents an onboarding request

​
links
object
​
meta
object

Was this page helpful?