GET
/
v1
/
guided-onboarding-sessions
/
{onboardingSessionId}
curl --request GET \
  --url https://platform.realto.io/api/v1/guided-onboarding-sessions/{onboardingSessionId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
onboardingSessionId
string
required

The id of the Guided Onboarding Session

Response

200
application/json
OK

A guided onboarding session

​
companyName
string | null
required

The company name displayed on the UI of the guided onboarding

​
id
string
required

The id of the guided onboarding session

​
created
string

The date and time the guided onboarding session was created

​
expired
boolean | null

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

​
manufacturer
string | null

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

​
onboardingRequest
object

Represents an onboarding request

​
vin
string | null

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

​
url
string | null

The url where the guided onboarding session can be accessed

Was this page helpful?