Skip to main content
GET
/
api
/
partners
/
v2.0
/
device-onboarding
/
{onboarding_session_id}
Get Device Onboarding Session
curl --request GET \
  --url https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/device-onboarding/{onboarding_session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "authentication_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success_url": "<string>",
  "cancel_url": "<string>",
  "is_smart_optimization_active_default": true,
  "expiration_date": "2023-12-25",
  "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_metadata": {},
  "language": "en"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

onboarding_session_id
string<uuid>
required

The ID of the specified device onboarding session

Response

200 - application/json

OK

authentication_url
string
required
id
string<uuid>
required
user
string<uuid>
required
success_url
string
required
Maximum string length: 8000
cancel_url
string
required
Maximum string length: 8000
price_zone_default
enum<string> | null
Available options:
AT,
AT_HOURLY,
BE,
CH,
EE,
DE_LU,
HU,
IT_CNOR,
IT_CSUD,
IT_NORD,
IT_PUN,
IT_SARD,
IT_SICI,
IT_SUD,
PT,
RO,
SE_1,
SE_2,
SE_3,
SE_4,
UK
is_smart_optimization_active_default
boolean | null
skip_to
enum<string> | null
Available options:
ev,
iv,
wb,
hp
expiration_date
string<date>
object_id
string<uuid> | null
external_metadata
External Metadata · object | null
language
string
default:en
Maximum string length: 255