Documentation

EVSE Access Control

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

API for management of group membership for local access to charging.

POST/1/access-groups

Create Access Group

Create an access group.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
accountIdstring
accountLegacyIdstring
authorizationModestring
restrictedunrestricted
default unrestricted
membersobject[]
_idstring
emailstring <email>
namestring
pricePerKwhnumber | any
priceTypestringREQUIRED
customdefaultfree
typestringREQUIRED
rfiduservisualNumber
uidstring
userIdstring
visualNumberstring
namestringREQUIRED
ownershipContextstringREQUIRED
accountuser
typestringREQUIRED
rfidusers
userEmailstring <email>
userIdstring
Responses
200OK application/json
dataAccessGroupResource
accountobject
accountIdstringREQUIRED
authorizationModestringREQUIRED
createdAtstringREQUIRED
idstringREQUIRED
membersAccessGroupMemberResource[]REQUIRED
idstringREQUIRED
namestring
nonBillableboolean
pricePerKwhnumber
priceTypestringREQUIRED
typestringREQUIRED
uidstring
userobject
idstringREQUIRED
namestringREQUIRED
visualNumberstring
membersHistoryobject[]REQUIRED
namestringREQUIRED
ownershipContextstringREQUIRED
providerIdstringREQUIRED
typestringREQUIRED
updatedAtstringREQUIRED
userIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized 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/access-groups/mine

List My Access Groups

List access groups for the current user.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
filenamestring
default access-groups.csv
formatstring
default json
fromstring <date-time>
idstring
idsstring[]
limitnumber
default 50
monthnumber
namestring
searchIdstring
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
typestring
rfidusers
yearnumber
Responses
200OK application/json
dataAccessGroupResource[]REQUIRED
accountobject
accountIdstringREQUIRED
authorizationModestringREQUIRED
createdAtstringREQUIRED
idstringREQUIRED
membersAccessGroupMemberResource[]REQUIRED
idstringREQUIRED
namestring
nonBillableboolean
pricePerKwhnumber
priceTypestringREQUIRED
typestringREQUIRED
uidstring
userobject
idstringREQUIRED
namestringREQUIRED
visualNumberstring
membersHistoryobject[]REQUIRED
namestringREQUIRED
ownershipContextstringREQUIRED
providerIdstringREQUIRED
typestringREQUIRED
updatedAtstringREQUIRED
userIdstring
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized 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
GET/1/access-groups/{accessGroup}

Get Access Group

Retrieve an access group.

Authorization
User sessionAPI credential
Permissions
access-groups:read
OAuth
-
Request
Path parameters1
accessGroupstringREQUIRED
Responses
200OK application/json
dataAccessGroupResource
accountobject
accountIdstringREQUIRED
authorizationModestringREQUIRED
createdAtstringREQUIRED
idstringREQUIRED
membersAccessGroupMemberResource[]REQUIRED
idstringREQUIRED
namestring
nonBillableboolean
pricePerKwhnumber
priceTypestringREQUIRED
typestringREQUIRED
uidstring
userobject
idstringREQUIRED
namestringREQUIRED
visualNumberstring
membersHistoryobject[]REQUIRED
namestringREQUIRED
ownershipContextstringREQUIRED
providerIdstringREQUIRED
typestringREQUIRED
updatedAtstringREQUIRED
userIdstring
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
PATCH/1/access-groups/{accessGroup}

Update Access Group

Update an access group.

Authorization
User sessionAPI credential
Permissions
access-groups:write
OAuth
-
Request
Path parameters1
accessGroupstringREQUIRED
Request bodyapplication/json
accountLegacyIdstring
authorizationModestring
restrictedunrestricted
default unrestricted
namestringREQUIRED
ownershipContextstringREQUIRED
accountuser
userEmailstring <email>
userIdstring
Responses
200OK application/json
dataAccessGroupResource
accountobject
accountIdstringREQUIRED
authorizationModestringREQUIRED
createdAtstringREQUIRED
idstringREQUIRED
membersAccessGroupMemberResource[]REQUIRED
idstringREQUIRED
namestring
nonBillableboolean
pricePerKwhnumber
priceTypestringREQUIRED
typestringREQUIRED
uidstring
userobject
idstringREQUIRED
namestringREQUIRED
visualNumberstring
membersHistoryobject[]REQUIRED
namestringREQUIRED
ownershipContextstringREQUIRED
providerIdstringREQUIRED
typestringREQUIRED
updatedAtstringREQUIRED
userIdstring
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
DELETE/1/access-groups/{accessGroup}

Delete Access Group

Delete an access group.

Authorization
User sessionAPI credential
Permissions
access-groups:write
OAuth
-
Request
Path parameters1
accessGroupstringREQUIRED
Responses
204OK text/plain
Returns a file (Text).
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/access-groups/{accessGroup}/member

Add Member

Add a member to an access group.

Authorization
User sessionAPI credential
Permissions
access-groups:write
OAuth
-
Rate limit
3000 / 5 min
Request
Path parameters1
accessGroupstringREQUIRED
Request bodyapplication/json
_idstring
emailstring <email>
namestring
pricePerKwhnumber | any
priceTypestringREQUIRED
customdefaultfree
typestringREQUIRED
rfiduservisualNumber
uidstring
userIdstring
visualNumberstring
Responses
204OK text/plain
Returns a file (Text).
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
429Too many requests: the rate limit was exceeded application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/access-groups/{accessGroup}/members/{id}

Remove Member

Remove a member from an access group.

Authorization
User sessionAPI credential
Permissions
access-groups:write
OAuth
-
Request
Path parameters2
accessGroupstringREQUIRED
idstringREQUIRED
Responses
204OK text/plain
Returns a file (Text).
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