Invites
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
Invite management
POST/1/invites/user
Invite User
Invite a new user to an account.
Authorization
User sessionAPI credentialPermissions
users:read-writeOAuth
-
Request
Request bodyapplication/json
accountRoleIdstring
emailstring <email>REQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
Responses
200OK application/json
dataInviteResponse
dataInviteResponse
accountIdstringREQUIRED
accountRoleIdstringREQUIRED
contactobjectREQUIRED
contactobjectREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
emailstringREQUIRED
idstringREQUIRED
providerIdstringREQUIRED
statusstringREQUIRED
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/invites/user/search
Search Users and Invites
List users and pending invites in the current account.
Authorization
User sessionAPI credentialPermissions
users:readOAuth
-
Request
Request bodyapplication/json
accountIdstring
limitnumber
default
50skipnumber
default
0sortobjectdefault {"field":"createdAt","order":"asc"}
sortobject
default
{"field":"createdAt","order":"asc"}fieldstringREQUIRED
orderstringREQUIRED
Responses
200OK application/json
dataUserOrInviteResponse[]
dataUserOrInviteResponse[]
accountIdstringREQUIRED
accountRolesobject[]REQUIRED
accountRolesobject[]REQUIRED
roleobjectREQUIRED
roleobjectREQUIRED
idstringREQUIRED
namestringREQUIRED
contactobjectREQUIRED
contactobjectREQUIRED
firstNamestring
lastNamestring
createdAtstringREQUIRED
creditLimitnumber
creditLimitAutoboolean
emailstringREQUIRED
fleetIdstring
fleetNamestring
idstringREQUIRED
providerIdstringREQUIRED
providerRolesobject[]REQUIRED
providerRolesobject[]REQUIRED
roleobjectREQUIRED
roleobjectREQUIRED
idstringREQUIRED
namestringREQUIRED
statusstringREQUIRED
typestringREQUIRED
usagenumber
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/invites/user/setup/charging-station
Invite User to Setup Charging Station
Send an invite to set up an account for a configured EVSE controller.
Authorization
User sessionAPI credentialPermissions
evse-controllers-maintenance:read-writeOAuth
-
Request
Request bodyapplication/json
customerEmailstring <email>REQUIRED
customerFirstNamestringREQUIRED
evseControllerIdstringREQUIRED
languageCodestringREQUIRED
Responses
202OK application/json
dataobject
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED