Release notes

2026-01-07

New Features:

• Added DeviceAccess > Copy permissions – copies device access to other users or groups.

2025-08-11

API v37 – BREAKING CHANGE ·

Migration note: Integrations using device access endpoints must adopt principalId and principalType; userEmail is now conditional on principal type.

Breaking Changes:

• [CHANGED] Access details extended with principalId, principalType, and principalName; userEmail is now required only for user access (principalType: 0).

• [CHANGED] principalId is required when creating access for user groups (principalType: 1).

New Features:

• Added complete Organization Groups management – create, update, and delete groups; manage members; grant device access to groups.

• Added principalType and principalId filters to device access endpoints.

Documentation:

• Updated How to manage device access guide with user group support.

Deprecations:

• API version v1.36 will be deprecated on 2026-08-11 and retired on 2027-02-11.

2025-06-09

New Features:

• Added Event type: LockPulledByAutoUnlock.

• Lock > Get all locks extended with Filters.AccessLevel to filter locks by Access level.

2025-04-22

New Features:

• Organization Device > Get organization devices response extended with connectedToId property (from API version 1.28).

2025-04-07

API v1.36 – BREAKING CHANGE ·

Migration note: Integrations using bridge pairing or unpairing endpoints must update their request and response handling.

Breaking Changes:

• [CHANGED] Schema of Bridge > Pair bridge with device endpoint updated.

• [CHANGED] Schema of Bridge > Unpair bridge from device endpoint updated.

Deprecations:

• API version v1.35 will be deprecated on 2026-04-07 and retired on 2026-10-07.

• The version v1.31 is retired.

2025-03-25

API v1.35 – BREAKING CHANGE ·

Migration note: Integrations reading organizationName or organizationSlug from lock responses, or using lockProperties, must update before adopting v1.35.

Breaking Changes:

• [REMOVED] organizationName and organizationSlug from Lock – no longer returned from GET Lock, GET All Locks, or Get devices with details.

• [RENAMED] lockProperties → deviceState in Lock Single Sync, Lock Sync, and all organization endpoints.

Deprecations:

• API version v1.34 will be deprecated on 2026-03-25 and retired on 2026-09-25.

• The version v1.30 is retired.

2025-02-10

New Features:

• Lock extended with DoorStateEventLoggingEnabled setting – enables or disables creation of DoorOpened and DoorClosed events from the door sensor in activity logs. Default: false.

2025-01-27

API v1.34 – BREAKING CHANGE ·

Migration note: Integrations using the Device Share area must migrate to the Device Access area; access data is now returned in accessDetails instead of shareDetails.

Breaking Changes:

• [CHANGED] Device Share area replaced by the Device Access area.

• [RENAMED] shareDetails → accessDetails in device access responses.

• [RENAMED] lockProperties → deviceState in the Lock model.

• [CHANGED] Access restrictions moved to access details.

Deprecations:

• API version v1.33 will be deprecated on 2026-01-27 and retired on 2026-07-27.

• The version v1.29 is retired.

2025-01-13

New Features:

• API v1.33 extended with Door Sensor Area for managing door sensor devices.

2024-12-16

New Features:

• Lock extended with AutoLockAfterDoorClosedEnabled setting – enables auto-locking after the door closes. Default: false.

• Added Event type: DoorOpenTooLong.

• Added Bell Button Pressed webhook event.

2024-11-18

New Features:

• Device > Transfer ownership extended with removeExistingShares parameter – if true, all existing shares are removed from transferred devices.

2024-11-04

New Features:

• Device > Transfer ownership now supports transferring multiple devices at once; pairings with devices outside the transfer request are automatically removed.

• deviceSettings removed from the dry contact model – dry contact configuration is now only possible through the mobile app.

2024-10-22

New Features:

• Added Device > Transfer ownership endpoint – transfers device ownership to another user (owner permission required).

Bug Fixes:

• Fixed: exception in Organization access link > Edit organization access link when changing device order.

2024-10-07

New Features:

• Lock > Get Accessories extended with AccessoryType parameter to filter accessories by type.

• Keypad model extended with deviceState, including batteryLevel and batteryLevelModifiedDateTime (returned only if no older than 30 days).

2024-09-23

API v1.33 – BREAKING CHANGE ·

Migration note: Integrations accessing accessories via direct lock fields or the old dedicated pair/unpair endpoints must switch to the accessories array and the new unified endpoints.

Breaking Changes:

• [REMOVED] connectedToDryContactId and connectedToKeypadId from Lock model; replaced by accessories array of type Lock Accessory [].

• [REMOVED] Lock > Pair lock with DryContact device endpoint.

• [REMOVED] Lock > Unpair lock from DryContact device endpoint.

• [REMOVED] Lock > Pair lock with Keypad device endpoint.

• [REMOVED] Lock > Unpair lock from Keypad device endpoint.

New Features:

• Added Lock > Pair Accessory endpoint – pairs any accessory type to a lock.

• Added revision field to Lock > Sync and Lock > Sync single endpoints.

• DeviceShare > Post Bulk response extended with user display name.

Deprecations:

• API version v1.32 will be deprecated on 2025-09-23 and retired on 2026-03-23.

• The version v1.25 is retired.

• The version v1.26 is retired.

• The version v1.27 is retired.

• The version v1.28 is retired.

2024-08-12

New Features:

• Added Lock > Get Accessories endpoint – returns accessories available to pair with the lock.

• Added Lock > Unpair Accessory endpoint – unpairs an accessory from a lock.

Bug Fixes:

• Fixed: BleBox devices now display correctly in the Tedee app after account linking.

2024-07-15

New Features:

• User > Delete account returns HTTP 412 Precondition Failed when the user owns an organization – the organization must be deleted first.

2024-07-02

New Features:

• Organization user > Add user to organization extended with role property.

• Personal access key global rate limit introduced: 1000 requests per hour.

2024-06-17

New Features:

• Added DryContact > Get all endpoint.

• Unlock gate extended with new HTTP statuses:

  • 412 Precondition Failed – no active BleBox integration.

  • 423 Locked – gate is disconnected.

2024-06-03

New Features:

• Added DryContact area with CRUD endpoints: Add, Update, Delete, Get.

• Lock area extended with Pair DryContact and Unpair DryContact endpoints.

• Lock extended with connectedToDryContactId property.

• Device > Get devices with details response extended with drycontacts[] array.

2024-02-19

New Features:

• Device settings extended with isAsync (hotel mode) property for lock devices.

2023-11-27

New Features:

• Bridge > Get paired devices response extended with serialNumber, softwareVersion, and state properties.

2023-10-30

New Features:

• Gate > Unlock Gate returns HTTP 408 Request Timeout when connecting to a BleBox device times out.

2023-10-16

New Features:

• Organization > Get organization permission matrix extended with Filters.Text (search by name or email) and Filters.DeviceId[] filters.

• Lock > Calibrate Lock and Calibrate Pull Spring now return HTTP 409 Conflict when bridge firmware is outdated.

2023-10-02

API v1.32 – BREAKING CHANGE ·

Migration note: Integrations using the old lock calibration endpoints must switch to the new Calibrate Lock and Calibrate Pull Spring endpoints.

Breaking Changes:

• [REMOVED] Old lock calibration endpoints; replaced by Lock > Calibrate Lock and Lock > Calibrate Pull Spring.

New Features:

• Lock device setting added: autoUnlockCancelOtherAutoUnlock – cancels other auto-unlocks when one triggers.

• User profile setting added: dynamicFirstLock – dynamically changes the first lock on the device list based on user location.

Deprecations:

• API version v1.31 will be deprecated on 2024-10-02 and retired on 2025-04-02.

2023-09-18

API v1.31 – BREAKING CHANGE ·

Migration note: Integrations passing UserId to organization endpoints must switch to OrganizationUserId.

Breaking Changes:

• [CHANGED] Organization > Get activities now takes OrganizationUserId instead of UserId.

• [CHANGED] Organization User > Get all user organization devices with permissions now takes OrganizationUserId instead of UserId; response extended with Timezone per device.

• [CHANGED] Organization User > Get organization user profile now takes OrganizationUserId instead of UserId; response extended with OrganizationUserId, UserId, and Roles.

New Features:

• Organization User > Add user to organization returns organizationUserId in the response body.

• Added Organization Device > Return all shares for specific device endpoint.

Deprecations:

• API version v1.30 will be deprecated on 2024-09-18 and retired on 2025-03-18.

• The version v1.22 is retired.

• The version v1.23 is retired.

• The version v1.24 is retired.

2023-08-07

New Features:

• Organization User > Get all users from organization extended with filter to search by name or email, and option to include pending users.

• Gate > Sync single extended with IncludeUserSetting parameter.

2023-07-24

New Features:

• Bridge extended with LocalApiEnabled setting.

• Rate limit applied to Get All Locks endpoint for personal access keys: 10 requests per 10 minutes.

• Organization endpoints extended with deviceType property.

2023-07-10

New Features:

• Organization access links extended with location support.

2023-06-26

New Features:

• Integration > Disconnect with BleBox extended with option to hard-delete gates.

2023-06-12

New Features:

• Added Gate > Delete Gate device endpoint.

• Gate extended with Location property and remote unlock setting.

• Gate > Unlock Gate updated: success now returns 204 No Content instead of 200 OK with no response body.

• Integration > Update linked BleBox account connection now supports personal access key authentication.

• OrganizationAccessLink description limit extended to 1000 characters.

• Device > Clone device data extended with userSettings cloning (DataToClone value: 4).

2023-05-29

New Features:

• Added Device > Clone device data endpoint – clones device settings and permissions to another device.

• Added Gate > Show all gates endpoint.

• Added Integration > Sync BleBox Accounts endpoint – synchronizes BleBox accounts with Tedee Cloud.

• Organization Access Link > Get organization access links now returns results sorted by name.

• Gate firmware version is returned in the softwareVersions property.

Bug Fixes:

• Fixed: guest users can now update gate settings via Gate > Update Gate device.

2023-05-15

New Features:

• OrganizationAccessLink name limited to 50 characters; description limited to 500 characters.

• Gate models extended with Icon property for selecting a predefined icon.

2023-04-10

New Features:

• Integration > Update linked BleBox account connection extended with optional organizationId parameter – assigns all BleBox devices to the specified organization.

Bug Fixes:

• Fixed: userEmail is now validated when creating a device share.

2023-03-27

API v1.30 – BREAKING CHANGE ·

New Features:

• Added organization access links management endpoints.

Deprecations:

• API version v1.29 will be deprecated on 2024-03-27 and retired on 2024-09-27.

• The version v1.19 is retired.

• The version v1.20 is retired.

• The version v1.21 is retired.

2022-12-05

API v1.29 – BREAKING CHANGE ·

Migration note: Integrations reading HoldToUnlock as a boolean must update to handle it as an enum value.

Breaking Changes:

• [CHANGED] HoldToUnlock user setting type changed from boolean to enum.

Deprecations:

• API version v1.28 will be deprecated on 2023-12-05 and retired on 2024-06-05.

• The version v1.16 is retired.

• The version v1.17 is retired.

• The version v1.18 is retired.

2022-08-16

API v1.28 – BREAKING CHANGE ·

Migration note: Integrations using the old organization endpoints must migrate to the unified organization/device area schema before adopting v1.28.

Breaking Changes:

• [REMOVED] Old organization endpoints.

• [CHANGED] Organization/device area schema unified.

Deprecations:

• API version v1.27 will be deprecated on 2023-08-16 and retired on 2024-02-16.

2022-07-18

API v1.27 – BREAKING CHANGE ·

Migration note: Integrations reading the unlocked notification from global user settings must remove this field before adopting v1.27.

Breaking Changes:

• [REMOVED] Unlocked notification from global user settings.

Deprecations:

• API version v1.26 will be deprecated on 2023-07-18 and retired on 2024-01-18.

2022-06-20

API v1.26 – BREAKING CHANGE ·

Migration note: Integrations consuming the my/lock endpoint must update to handle paged responses.

Breaking Changes:

• [CHANGED] my/lock endpoint now returns paged and filterable results.

New Features:

• Added support for device notification settings.

• my/lock endpoint extended with IncludeOrganization parameter.

Deprecations:

• API version v1.25 will be deprecated on 2023-06-20 and retired on 2023-12-20.

2022-02-28

New Features:

• Lock extended with user setting for WiFi checking in auto-unlock.

2022-01-31

New Features:

• Keypad extended with setting to enable or disable lock action by keypad button.

• Added event types: LockedByKeypadWithPin and LockedByKeypadWithoutPin.

2022-01-17

New Features:

• Keypad is now automatically paired with bridge when paired with a lock.

Deprecations:

• API version 1.9 retired.

2021-12-20

API v1.25 – BREAKING CHANGE ·

Breaking Changes:

• [CHANGED] Keypad sound volume values are now restricted to an allowed range.

New Features:

• Keypad extended with batteryType setting.

Deprecations:

• API version v1.24 will be deprecated on 2022-12-20 and retired on 2023-06-20.

2021-11-22

API v1.24 – BREAKING CHANGE ·

New Features:

• Keypad extended with setting to enable or disable the bell button.

Deprecations:

• API version v1.23 will be deprecated on 2022-11-22 and retired on 2023-05-22.

2021-11-08

API v1.23 – BREAKING CHANGE ·

Migration note: Integrations using mobile device identifiers must update from integer to UUID format.

Breaking Changes:

• [CHANGED] Mobile device identifier type changed from integer to UUID.

Deprecations:

• API version v1.22 will be deprecated on 2022-11-08 and retired on 2023-05-08.

2021-10-25

New Features:

• Mobile endpoint extended with Other as a supported operating system.

2021-10-11

New Features:

• Timezone validation added for devices.

• Added endpoints for keypad PIN list management.

• Request rate limit added on lock sync endpoints.

• my prefix added to personal access key endpoints.

• Email notification sent after creating a personal access key.

2021-09-27

API v1.22 – BREAKING CHANGE ·

Migration note: Integrations creating device shares must remove accessType from requests; integrations using the unlock endpoint must update to the new default mode (no auto-pull) and explicitly use the new unlock or pull spring mode when pull spring behavior is needed.

Breaking Changes:

• [REMOVED] accessType property from POST/PATCH device share endpoints.

• [CHANGED] Default unlock mode changed to “not pull”; new unlock or pull spring mode added for explicit pull behavior when the lock is already unlocked.

New Features:

• Personal access key maximum expiration extended to 5 years.

Deprecations:

• API version v1.21 will be deprecated on 2022-09-27 and retired on 2023-03-27.

2021-09-13

New Features:

• User authentication via personal access key introduced.

• Recurring device share can now be configured with only start/end times or only weekdays (both no longer required together).

2021-08-30

API v1.21 – BREAKING CHANGE ·

Bug Fixes:

• Fixed: issue with deleting a bridge.

Deprecations:

• API version v1.20 will be deprecated on 2022-08-30 and retired on 2023-02-28.

2021-08-16

API v1.20 – BREAKING CHANGE ·

Migration note: Integrations using lock, unlock, or pull spring operations must update to pass all parameters in the path instead of the request body.

Breaking Changes:

• [CHANGED] Lock/unlock/pull operation endpoints refactored – all parameters are now in the path, not the request body.

New Features:

• Unlock operation extended with without auto pull spring mode.

Deprecations:

• API version v1.19 will be deprecated on 2022-08-16 and retired on 2023-02-16.

2021-08-02

New Features:

• Keypad pair/unpair endpoints moved to the Lock area.

• Lock model extended with connectedToKeypadId property.

2021-06-21

New Features:

• Added endpoints to pair and unpair keypad with lock.

• Keypad extended with timezone.

Bug Fixes:

• Fixed: device share can now be removed when the device is in an organization.

2021-06-07

New Features:

• Added endpoints to manage keypad devices.

2021-05-24

API v1.19 – BREAKING CHANGE ·

Migration note: Integrations using the Bridge update endpoint must switch from PUT to PATCH.

Breaking Changes:

• [REMOVED] Bridge PUT update endpoint; replaced by PATCH.

New Features:

• Lock and bridge devices extended with timezone.

Deprecations:

• API version v1.18 will be deprecated on 2022-05-24 and retired on 2022-11-24.

2021-05-10

API v1.18 – BREAKING CHANGE ·

Migration note: Integrations calling the unregister endpoint on StandardNotificationHub must remove this call.

Breaking Changes:

• [REMOVED] unregister endpoint from StandardNotificationHub.

Deprecations:

• API version v1.17 will be deprecated on 2022-05-10 and retired on 2022-11-10.

2021-04-26

API v1.17 – BREAKING CHANGE ·

Migration note: Integrations handling close/open/pull responses must update to 202 Accepted and poll the new status endpoint for operation results.

Breaking Changes:

• [CHANGED] Close/open/pull operation requests now return 202 Accepted; response includes lastStateChangedDate.

New Features:

• Added endpoint to check close/open/pull operation status.

• lastStateChangedDate and stateChangeResult added to all endpoints returning lock state.

Deprecations:

• API version v1.16 will be deprecated on 2022-04-26 and retired on 2022-10-26.

2021-01-18

API v1.16 – BREAKING CHANGE ·

Migration note: Integrations reading user settings directly from lock properties, or relying on bridgeId, connectedToId, iotDeviceName, or voipNumber, must update before adopting v1.16.

Breaking Changes:

• [CHANGED] All user settings moved from individual lock properties to the new userSettings property in the Lock type.

• [REMOVED] bridgeId from the Lock type.

• [REMOVED] connectedToId, iotDeviceName, and voipNumber from the Bridge type.

2020-12-07

New Features:

• Bridge software update status added to bridge information.

• Lock state is now returned as an enum.

Deprecations:

• API versions 1.10, 1.11, and 1.12 retired.

2020-11-23

New Features:

• Scopes applied to all API endpoints.

• Added new endpoints for lock synchronization.

• API versions in Swagger sorted in descending order.