Get all

Get a list of all currently logged user locks. Filters.OrganizationIds accept ‘null’ as value, then private locks (which don’t belong to any organization) are returned.

GET https://api.tedee.com/api/v1.30/my/lock

URI Parameters

Name

Type

Description

Filters.BatteryLevel

integer (optional)

battery level of lock

Filters.OrganizationIds

string[] (optional)

id of organizations

Filters.State

int[] (optional)

states of lock

Filters.Text

string (optional)

text to filter

Filters.UpdateAvailable

boolean (optional)

updateAvailable on lock

IncludeOrganization

boolean (optional)

should organizations be included

includeUserSettings

boolean (optional)

should userSettings be included

ItemsPerPage

integer (optional)

count of items on page

Page

integer (optional)

number of page

Responses

Name

Type

Description

200 OK

Lock []

successful operation

Scopes

Name

Description

Device.Read

Grants user possibility to read data connected with devices

Device.ReadWrite

Grants user possibility to read and write data connected with devices

Examples

Get all locks of currently logged user

Sample Request

curl -X GET "https://api.tedee.com/api/v1.30/my/lock" -H "accept: application/json" -H "Authorization: Bearer <<access token>>"

Sample response

HTTP status code: 200

{
    "result": [
        {
            "deviceSettings": {
                "autoLockEnabled": true,
                "autoLockDelay": 10,
                "autoLockImplicitEnabled": false,
                "autoLockImplicitDelay": 10,
                "pullSpringEnabled": true,
                "pullSpringDuration": 10,
                "autoPullSpringEnabled": false,
                "postponedLockEnabled": false,
                "postponedLockDelay": 10,
                "buttonLockEnabled": false,
                "buttonUnlockEnabled": false
            },
            "userSettings": {
                "autoUnlockEnabled": true,
                "autoUnlockConfirmEnabled": true,
                "autoUnlockRangeIn": 300,
                "autoUnlockRangeOut": 400,
                "autoUnlockTimeout": 20,
                "location": {
                    "latitude": 52.24070739746092,
                    "longitude": 21.086990356445305
            },
            "lockProperties": {
                "state": 3,
                "isCharging": false,
                "batteryLevel": 18,
                "stateChangeResult": 0,
                "lastStateChangedDate": "2021-04-26T06:02:04.197Z"
            },
            "beaconMajor": 56,
            "beaconMinor": 57,
            "timeZone": "Europe/Warsaw",
            "id": 1,
            "connectedToId": 2,
            "serialNumber": "111111-11111",
            "name": "Room 6",
            "userIdentity": "bcc1fdc9-13ee-43b3-a13e-eaba8eaf7996",
            "type": 2,
            "created": "2020-01-01T00:00:00",
            "revision": 2,
            "deviceRevision": 2,
            "targetDeviceRevision": 2,
            "isConnected": true,
            "accessLevel": 2,
            "shareDetails": null,
            "softwareVersions": [
                {
                    "softwareType": 0,
                    "version": "1.0.0",
                    "updateAvailable": true
                }
            ]
        }
    ]
    "success": true,
    "errorMessages": [],
    "statusCode": 200
}