Skip to main content
GET
Retrieve Entity Onboarding Requests

Authorizations

Authorization
string
header
required

Access Token Authentication

Query Parameters

brand
string

The brand to filter on

type
enum<string>

The type to filter on

Available options:
Battery,
ChargePoint,
EV,
HeatPump,
SolarPlant,
RetrofitMeter,
Meter,
Inverter
identifier
string

The identifier 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,
RefreshConnection
pageSize
integer<int32>
default:25

The number of Entity Onboarding Requests per page

continuationToken
string

The token used to retrieve the next page

Response

OK

A page of onboarding requests

data
object[] | null
meta
object