List all Guided Onboarding Sessions

API Reference

Core Resources

Entities
Collectives
Tenants

Onboarding API

Readings API

Readings
Aggregations

Commands API

Charge Sessions API

GET
List all Charge Sessions

Entity Settings

Features
Locations
Battery Capacity
Heated Area
Disaggregators
Custom Properties

Offboarding API

Offboard Entities

GET

guided-onboarding-sessions

curl --request GET \
  --url https://platform.realto.io/api/v1/guided-onboarding-sessions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "companyName": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "expired": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "manufacturer": "<string>",
      "onboardingRequest": {
        "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>"
          }
        ]
      },
      "vin": "<string>",
      "url": "<string>"
    }
  ],
  "links": {
    "next": "<string>"
  },
  "meta": {
    "continuationToken": "<string>",
    "pageSize": 123
  }
}

Authorizations

Authorization

string

header

required

Access Token Authentication

Query Parameters

pageSize

integer

default:25

The number of Guided Onboarding Sessions per page

continuationToken

string

The token used to retrieve the next page

Response

200

application/json

A page of guided onboarding sessions

data

object[] | null

A guided onboarding session

data.companyName

string | null

required

The company name displayed on the UI of the guided onboarding

data.id

string

required

The id of the guided onboarding session

data.created

string

The date and time the guided onboarding session was created

data.expired

boolean | null

Is true when the guided onboarding session is expired, false otherwise

data.manufacturer

string | null

The manufacturer of the Entity that will be onboarded through the guided onboarding session

data.onboardingRequest

object

Represents an onboarding request

data.onboardingRequest.action

object

Represents an action for an onboarding request

data.onboardingRequest.created

string

The date and time the onboarding request was created.

data.onboardingRequest.data

object

Represents the data of an onboarding request

data.onboardingRequest.data.collective

object

Represents data required to onboard a Collective

data.onboardingRequest.data.entity

object

Represents data required to onboard an Entity

data.onboardingRequest.data.tenant

object

Represents data required to onboard a Tenant

data.onboardingRequest.data.user

object

Represents data required to onboard a User

data.onboardingRequest.data.client

object

Represents data required to onboard a Client

data.onboardingRequest.id

string

The id of the onboarding request

data.onboardingRequest.principalId

string

The id of the principal that initiated the onboarding request

data.onboardingRequest.requestType

enum<string>

Available options:

Collective,

Entity,

Tenant,

User,

Client

data.onboardingRequest.returnUrl

string | null

The url where the User will be redirected to after completing the consent flow on the OEM page.

data.onboardingRequest.status

enum<string>

Available options:

Canceled,

Failed,

InProgress,

Pending,

Succeeded

data.onboardingRequest.errors

object[] | null

Errors that occurred during the processing of the onboarding request

An error that occurred during the onboarding request

data.vin

string | null

The VIN of the Entity that will be onboarded through the guided onboarding session

data.url

string | null

The url where the guided onboarding session can be accessed

links

object

meta

object

Was this page helpful?

Retrieve a Guided Onboarding Session Create a Guided Onboarding Session

curl --request GET \
  --url https://platform.realto.io/api/v1/guided-onboarding-sessions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "companyName": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "expired": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "manufacturer": "<string>",
      "onboardingRequest": {
        "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>"
          }
        ]
      },
      "vin": "<string>",
      "url": "<string>"
    }
  ],
  "links": {
    "next": "<string>"
  },
  "meta": {
    "continuationToken": "<string>",
    "pageSize": 123
  }
}