← Account API

GET/v1/accountGet current account

Get the account that belongs to the current session
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok, returned found account
status401Invalid authentication token
status403Insufficient rights
status404Account not found
{
"id" : Number,
"firstName" : String,
"lastName" : String,
"email" : String,
"emailSuppression" : Boolean,
"phone" : Phone number (E.164, e.g. "+31850607337"),
"phoneCountryCode" : String,
"emailIsVerified" : Boolean,
"language" : Language code (ISO 639-1, e.g. "ar", "de", "en", "es", "fr", "it", "nl", "pl", "cs"),
"isSystemAccount" : Boolean,
"isSupportAccount" : Boolean,
"isDistributorAccount" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"isSystemIntegration" : Boolean,
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"datePreliminary" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateLastAuthentication" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateLastActivation" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"personalOrganization" : {
"id" : Number,
"name" : String,
"personal" : Boolean,
"restricted" : Boolean,
"subscriptionId" : String,
"creatorAccountId" : Number,
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"permissions" : {
"rangeBoostMode" : Boolean,
"unlimitedUsers" : Boolean,
"remoteAccess" : Boolean,
"backupPins" : Boolean,
"shareAccess" : Boolean,
"eventLog" : Boolean,
"turnToActivate" : Boolean,
"tailgaterProtection" : Boolean,
"matter" : Boolean,
"turnToBoost" : Boolean,
"lockedStatus" : Boolean,
"buttonAutoDisable" : Boolean,
"powerSaveMode" : Boolean,
"nightLock" : Boolean,
"leaveAlert" : Boolean,
"tamperDetection" : Boolean,
"webKeys" : Boolean,
"dynamicPins" : Boolean,
"extendedEventLog" : Boolean,
"keepActiveMode" : Boolean,
"showRealUser" : Boolean,
"portal" : Boolean,
"deviceGroups" : Boolean,
"userGroups" : Boolean,
"temporaryShares" : Boolean,
"managedClickers" : Boolean,
"importUsers" : Boolean,
"exportEvents" : Boolean,
"userInviteEmail" : Boolean,
"userInviteSms" : Boolean,
"userInviteWhatsapp" : Boolean,
"integration" : Boolean,
"customClient" : Boolean,
"eventWebhooks" : Boolean,
"autoEmailMatch" : Boolean,
"requireEmailMatch" : Boolean,
"emailMatchCredentialFilter" : Boolean,
"nfcActivationTag" : Boolean,
"walkInMode" : Boolean,
"createOrganizations" : Boolean
}
},
"users" : [{
"id" : Number,
"organization" : {
"id" : Number,
"name" : String,
"personal" : Boolean,
"restricted" : Boolean,
"subscriptionId" : String,
"creatorAccountId" : Number,
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"permissions" : {
"rangeBoostMode" : Boolean,
"unlimitedUsers" : Boolean,
"remoteAccess" : Boolean,
"backupPins" : Boolean,
"shareAccess" : Boolean,
"eventLog" : Boolean,
"turnToActivate" : Boolean,
"tailgaterProtection" : Boolean,
"matter" : Boolean,
"turnToBoost" : Boolean,
"lockedStatus" : Boolean,
"buttonAutoDisable" : Boolean,
"powerSaveMode" : Boolean,
"nightLock" : Boolean,
"leaveAlert" : Boolean,
"tamperDetection" : Boolean,
"webKeys" : Boolean,
"dynamicPins" : Boolean,
"extendedEventLog" : Boolean,
"keepActiveMode" : Boolean,
"showRealUser" : Boolean,
"portal" : Boolean,
"deviceGroups" : Boolean,
"userGroups" : Boolean,
"temporaryShares" : Boolean,
"managedClickers" : Boolean,
"importUsers" : Boolean,
"exportEvents" : Boolean,
"userInviteEmail" : Boolean,
"userInviteSms" : Boolean,
"userInviteWhatsapp" : Boolean,
"integration" : Boolean,
"customClient" : Boolean,
"eventWebhooks" : Boolean,
"autoEmailMatch" : Boolean,
"requireEmailMatch" : Boolean,
"emailMatchCredentialFilter" : Boolean,
"nfcActivationTag" : Boolean,
"walkInMode" : Boolean,
"createOrganizations" : Boolean
}
},
"isSuperUser" : Boolean,
"permissions" : [String]
}],
"agreements" : [{
"agreementType" : "TERMS_OF_SERVICE" / "END_USER_LICENSE_AGREEMENT" / "DATA_PROCESSING_AGREEMENT",
"version" : Number,
"url" : String,
"startDate" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"accepted" : Boolean
}],
"appDebugLog" : Boolean,
"passwordStrength" : Number,
"securityClient" : {
"clientInstanceId" : Number,
"accountId" : Number,
"organizationId" : Number,
"clientId" : Number,
"clientPermissions" : {
"read" : Boolean,
"events" : Boolean,
"activate" : Boolean,
"settings" : Boolean,
"manage" : Boolean,
"impersonate" : Boolean,
"authorize" : Boolean
},
"clientRequirements" : {
"permissionIntegration" : Boolean
},
"isImpersonated" : Boolean
},
"credentials" : [{
"credentialType" : "Google" / "Apple" / "Azure" / "Password",
"emailAddress" : String,
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00")
}]
}

Example: Get account, using the current API context

GET/v1/account

headerAuthorizationBearer b6caa701-f2cb-4924-9b38-e173a0c700e8

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1,
"firstName": "Jane",
"email": "sesam@example.com",
"emailSuppression": false,
"phone": "+40711111298",
"emailIsVerified": false,
"isSystemAccount": false,
"isSupportAccount": false,
"isSystemIntegration": false,
"dateCreated": "2026-03-10T09:34:57.555376Z",
"users": [],
"agreements": [{
"agreementType": "TERMS_OF_SERVICE",
"version": 2,
"url": "/en/boldsmartlock_2021_eula.pdf",
"startDate": "2026-02-10T09:34:57.925095Z",
"accepted": false
}],
"appDebugLog": false,
"passwordStrength": 0,
"securityClient": {
"clientInstanceId": 1,
"accountId": 1,
"clientId": 2,
"clientPermissions": {
"read": false,
"events": false,
"activate": false,
"settings": false,
"manage": false,
"impersonate": false,
"authorize": false
},
"clientRequirements": {
"permissionIntegration": false
},
"isImpersonated": false
},
"credentials": [{
"credentialType": "Password",
"emailAddress": "sesam@example.com",
"dateCreated": "2026-03-10T09:34:57.890653Z"
}]
}