Users

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

POST/1/users

Create User

Authorization
User sessionAPI credential
Permissions
users:write
OAuth
-
Request
Request bodyapplication/json
accountIdstring
accountLegacyIdstring
accountRolestring
accountRolesobject[]
accountIdstringREQUIRED
roleIdstringREQUIRED
billingobject
accountHolderNamestring
addressstring
addressLine2string | null
bicNostring | null
citystring | null
countryCodestring | null
ibanNostring | null
paymentMethodstringREQUIRED
autopaymanual
postalCodestring | null
regionstring | null
contactany | object
firstNamestring | null
genderstring | null
lastNamestring | null
phoneCountryCodestring | null
phoneNostring | null
creditBillingobject
accountHolderNamestring
addressstring | null
addressLine2string | null
bicNostring | null
citystring | null
countryCodestring | null
ibanNostring | null
postalCodestring | null
regionstring | null
creditLimitnumber | null
creditLimitAutoboolean
defaultLangCodestring
emailstring <email>REQUIRED
externalIdstring
globalRolesobject[]
roleIdstring
legacyIdstring
migratedboolean
providerRolesobject[]
providerIdstring
roleIdstring
sourcestring
referralstring | null
rolesstring[]
signupCompletedboolean
systemRolesobject[]
roleIdstring
themestring
darklightsystem
default system
timeZonestring
Responses
201User Created application/json
dataUserResource
acceptanceDatestring
accountobject
accountIdstring
accountRolesobject[]
accountIdstringREQUIRED
roleIdstring | objectREQUIRED
addressobject
addressstring
addressLine2string
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
regionstring
billingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
emailstring
ibanNostring
paymentMethodstring
postalCodestring
regionstring
contactobject
firstNamestring
genderstring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring
createdAtstring
creditBillingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
ibanNostring
postalCodestring
creditLimitnumber
creditLimitAutoboolean
creditNumericReferenceCodenumber
defaultContextstring
accountorg
defaultLangCodestring
emailstring
emailVerifiedAtstring
exactCreditAccountCodestring
exactCreditAccountIdstring
exactCreditBankAccountIdstring
exactCreditMandateIdstring
externalIdstring
globalRolesobject[]
roleIdstring | objectREQUIRED
hsContactIdstring
idstringREQUIRED
intercomContactIdstring
isActiveboolean
labelsstring[]
legacyIdstring
mfaUserMfaState
loginFactorsstring[]REQUIRED
recoveryFactorsstring[]REQUIRED
namestring
netSuiteAccountIdstring
netSuiteMandateIdstring
passwordUpdatedAtstring
providerIdstring
providerRolesobject[]
providerIdstringREQUIRED
roleIdstring | objectREQUIRED
referralstring
rolesstring[]
signupobject
billingPlanIdstring
completedAtstring
evseIdstring
journeystring
platformstring
stationSerialNumberstring
signupCompletedboolean
systemRolesobject[]
roleIdstring | objectREQUIRED
themestring
timeZonestring
updatedAtstring
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/users/search/fast

Search Users

Authorization
User sessionAPI credential
Permissions
users:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
accountsstring[]
createdAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
fromstring <date-time>
idstring
idsstring[]
importIdstring
labelsstring[]
limitnumber
default 50
namestring
rolesstring[]
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
tostring <date-time>
Responses
200OK application/json
dataUserResource[]
acceptanceDatestring
accountobject
accountIdstring
accountRolesobject[]
accountIdstringREQUIRED
roleIdstring | objectREQUIRED
addressobject
addressstring
addressLine2string
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
regionstring
billingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
emailstring
ibanNostring
paymentMethodstring
postalCodestring
regionstring
contactobject
firstNamestring
genderstring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring
createdAtstring
creditBillingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
ibanNostring
postalCodestring
creditLimitnumber
creditLimitAutoboolean
creditNumericReferenceCodenumber
defaultContextstring
accountorg
defaultLangCodestring
emailstring
emailVerifiedAtstring
exactCreditAccountCodestring
exactCreditAccountIdstring
exactCreditBankAccountIdstring
exactCreditMandateIdstring
externalIdstring
globalRolesobject[]
roleIdstring | objectREQUIRED
hsContactIdstring
idstringREQUIRED
intercomContactIdstring
isActiveboolean
labelsstring[]
legacyIdstring
mfaUserMfaState
loginFactorsstring[]REQUIRED
recoveryFactorsstring[]REQUIRED
namestring
netSuiteAccountIdstring
netSuiteMandateIdstring
passwordUpdatedAtstring
providerIdstring
providerRolesobject[]
providerIdstringREQUIRED
roleIdstring | objectREQUIRED
referralstring
rolesstring[]
signupobject
billingPlanIdstring
completedAtstring
evseIdstring
journeystring
platformstring
stationSerialNumberstring
signupCompletedboolean
systemRolesobject[]
roleIdstring | objectREQUIRED
themestring
timeZonestring
updatedAtstring
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
GET/1/users/{user}

Get User

Authorization
User sessionAPI credential
Permissions
users:read
OAuth
-
Request
Path parameters1
userstringREQUIRED
Responses
200User application/json
dataUserResource
acceptanceDatestring
accountobject
accountIdstring
accountRolesobject[]
accountIdstringREQUIRED
roleIdstring | objectREQUIRED
addressobject
addressstring
addressLine2string
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
regionstring
billingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
emailstring
ibanNostring
paymentMethodstring
postalCodestring
regionstring
contactobject
firstNamestring
genderstring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring
createdAtstring
creditBillingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
ibanNostring
postalCodestring
creditLimitnumber
creditLimitAutoboolean
creditNumericReferenceCodenumber
defaultContextstring
accountorg
defaultLangCodestring
emailstring
emailVerifiedAtstring
exactCreditAccountCodestring
exactCreditAccountIdstring
exactCreditBankAccountIdstring
exactCreditMandateIdstring
externalIdstring
globalRolesobject[]
roleIdstring | objectREQUIRED
hsContactIdstring
idstringREQUIRED
intercomContactIdstring
isActiveboolean
labelsstring[]
legacyIdstring
mfaUserMfaState
loginFactorsstring[]REQUIRED
recoveryFactorsstring[]REQUIRED
namestring
netSuiteAccountIdstring
netSuiteMandateIdstring
passwordUpdatedAtstring
providerIdstring
providerRolesobject[]
providerIdstringREQUIRED
roleIdstring | objectREQUIRED
referralstring
rolesstring[]
signupobject
billingPlanIdstring
completedAtstring
evseIdstring
journeystring
platformstring
stationSerialNumberstring
signupCompletedboolean
systemRolesobject[]
roleIdstring | objectREQUIRED
themestring
timeZonestring
updatedAtstring
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
PATCH/1/users/{user}

Update User

Authorization
User sessionAPI credential
Permissions
users:write
OAuth
-
Request
Path parameters1
userstringREQUIRED
Request bodyapplication/json
accountIdstring
accountLegacyIdstring
accountRolestring
accountRolesobject[]
accountIdstringREQUIRED
roleIdstringREQUIRED
addressobject
addressstring | null
addressLine2string | null
citystring | null
countryCodestring | null
firstNamestring | null
lastNamestring | null
postalCodestring | null
regionstring | null
billingobject
accountHolderNamestring
addressstring
addressLine2string | null
bicNostring | null
citystring | null
countryCodestring | null
ibanNostring | null
paymentMethodstringREQUIRED
autopaymanual
postalCodestring | null
regionstring | null
contactany | object
firstNamestring | null
genderstring | null
lastNamestring | null
phoneCountryCodestring | null
phoneNostring | null
createdAtstring <date-time>
creditBillingobject
accountHolderNamestring
addressstring | null
addressLine2string | null
bicNostring | null
citystring | null
countryCodestring | null
ibanNostring | null
postalCodestring | null
regionstring | null
creditLimitnumber | null
creditLimitAutoboolean
defaultLangCodestring
deletedAtstring <date-time>
emailstring <email>
externalIdstring
globalRolesobject[]
roleIdstring
labelsstring[]
legacyIdstring
providerRolesobject[]
providerIdstring
roleIdstring
sourcestring
referralstring | null
rolesstring[]
signupCompletedboolean
systemRolesobject[]
roleIdstring
themestring
darklightsystem
default system
timeZonestring
updatedAtstring <date-time>
Responses
200User application/json
dataUserResource
acceptanceDatestring
accountobject
accountIdstring
accountRolesobject[]
accountIdstringREQUIRED
roleIdstring | objectREQUIRED
addressobject
addressstring
addressLine2string
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
regionstring
billingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
emailstring
ibanNostring
paymentMethodstring
postalCodestring
regionstring
contactobject
firstNamestring
genderstring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring
createdAtstring
creditBillingobject
accountHolderNamestring
addressstring
addressLine2string
bicNostring
citystring
countryCodestring
ibanNostring
postalCodestring
creditLimitnumber
creditLimitAutoboolean
creditNumericReferenceCodenumber
defaultContextstring
accountorg
defaultLangCodestring
emailstring
emailVerifiedAtstring
exactCreditAccountCodestring
exactCreditAccountIdstring
exactCreditBankAccountIdstring
exactCreditMandateIdstring
externalIdstring
globalRolesobject[]
roleIdstring | objectREQUIRED
hsContactIdstring
idstringREQUIRED
intercomContactIdstring
isActiveboolean
labelsstring[]
legacyIdstring
mfaUserMfaState
loginFactorsstring[]REQUIRED
recoveryFactorsstring[]REQUIRED
namestring
netSuiteAccountIdstring
netSuiteMandateIdstring
passwordUpdatedAtstring
providerIdstring
providerRolesobject[]
providerIdstringREQUIRED
roleIdstring | objectREQUIRED
referralstring
rolesstring[]
signupobject
billingPlanIdstring
completedAtstring
evseIdstring
journeystring
platformstring
stationSerialNumberstring
signupCompletedboolean
systemRolesobject[]
roleIdstring | objectREQUIRED
themestring
timeZonestring
updatedAtstring
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
DELETE/1/users/{user}

Delete User

Authorization
User sessionAPI credential
Permissions
users:write
OAuth
-
Request
Path parameters1
userstringREQUIRED
Responses
204User deleted 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/users/{user}/force-logout

Force Logout User

Authorization
User sessionAPI credential
Permissions
users:write
OAuth
-
Request
Path parameters1
userstringREQUIRED
Request bodyapplication/json
forcePasswordResetboolean
default false
revokeAllDevicesboolean
default false
Responses
204User forced logout 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