Documentation

Tokens

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

Token Management APIs

POST/1/tokens/search/fast

Fast Search Tokens

Search tokens using fast search.

Authorization
User sessionAPI credential
Permissions
tokens:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring | null
batchIdstring
createdAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
customIdstring
excludeEmptyCustomIdboolean
fromstring <date-time>
hasMaintenanceAccessboolean
idstring
idsstring[]
importIdstring
includeEmptyUidboolean
isAssignedboolean
isAssignedAndBlockedboolean
isUnassignedboolean
keywordsstring
limitnumber
default 50
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
uidstring
visualNumberstring
Responses
200OK application/json
dataTokenSearch[]
accountobject
namestring
accountIdstring
billingPlanobject
namestring
billingPlanIdstring
contractIdstring
createdAtstring <date-time>REQUIRED
customIdstring
emi3Contractobject
checksumDigitstring
countryCodestring
emaInstancestring
idTypestring
partyIdstring
hasMaintenanceAccessbooleanREQUIRED
idstringREQUIRED
isActiveboolean
isBlockedboolean
providerIdstringREQUIRED
uidstring
userobject
emailstring
namestring
userIdstring
visualNumberstring
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
GET/1/tokens/{token}

Get Token

Returns a single token.

Authorization
User sessionAPI credential
Permissions
tokens:read
OAuth
-
Request
Path parameters1
tokenstringREQUIRED
Responses
200OK application/json
dataTokenResource
accountIdstring
batchIdstring
billingPlanobject
billingPlanIdstring
cardobject
createdAtstringREQUIRED
creditLimitExceededboolean
customIdstring
fleetIdstring
hasMaintenanceAccessboolean
idstringREQUIRED
importsobject
isActivebooleanREQUIRED
isBlockedbooleanREQUIRED
providerIdstringREQUIRED
roamingModestring
typestring
uidstring
updatedAtstringREQUIRED
userobject
userIdstring
validbooleanREQUIRED
visualNumberstring
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