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.

POST/1/invites/user

Invite User

Authorization
User sessionAPI credential
Permissions
users:read-write
OAuth
-
Request
Request bodyapplication/json
accountRoleIdstring
emailstring <email>REQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
Responses
200OK application/json
dataInviteResponse
accountIdstringREQUIRED
accountRoleIdstringREQUIRED
contactobjectREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
emailstringREQUIRED
idstringREQUIRED
providerIdstringREQUIRED
statusstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/invites/user/search

Search Users and Invites

Authorization
User sessionAPI credential
Permissions
users:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
limitnumber
default 50
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"asc"}
fieldstringREQUIRED
orderstringREQUIRED
Responses
200OK application/json
dataUserOrInviteResponse[]
accountIdstringREQUIRED
accountRolesobject[]REQUIRED
roleobjectREQUIRED
idstringREQUIRED
namestringREQUIRED
contactobjectREQUIRED
firstNamestring
lastNamestring
createdAtstringREQUIRED
creditLimitnumber
creditLimitAutoboolean
emailstringREQUIRED
fleetIdstring
fleetNamestring
idstringREQUIRED
providerIdstringREQUIRED
providerRolesobject[]REQUIRED
roleobjectREQUIRED
idstringREQUIRED
namestringREQUIRED
statusstringREQUIRED
typestringREQUIRED
usagenumber
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/invites/user/setup/charging-station

Invite User to Setup Charging Station

Authorization
User sessionAPI credential
Permissions
evse-controllers-maintenance:read-write
OAuth
-
Request
Request bodyapplication/json
customerEmailstring <email>REQUIRED
customerFirstNamestringREQUIRED
evseControllerIdstringREQUIRED
languageCodestringREQUIRED
Responses
202OK application/json
dataobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED