SmartLocks

List property smart locks

GET

/v1/properties/{id}/smartlocks

Returns every smart lock assigned to the property together with its current lock/battery status fetched from the underlying provider (Nuki or Unifi).

List property smart locks › path Parameters

id

string · required

Property id

List property smart locks › Responses

Smart locks with their live status

SmartLock[]

SmartLock

id

string · uuid · required

vendor

string · required

name

string · required

property_id

string · uuid · required

lock_state

integer | null

battery_level

integer | null

battery_charging

boolean | null

offline

boolean

GET/v1/properties/{id}/smartlocks

curl /v1/properties/:id/smartlocks \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "vendor": "vendor",
    "name": "name",
    "property_id": "00000000-0000-0000-0000-000000000000",
    "nuki_smartlock": {
      "id": "00000000-0000-0000-0000-000000000000",
      "nuki_smartlock_id": "nuki_smartlock_id"
    },
    "unifi_smartlock": {
      "floor_id": "floor_id",
      "door_id": "door_id",
      "name": "name",
      "assigned_property": {
        "property_id": "00000000-0000-0000-0000-000000000000",
        "property_name": "property_name",
        "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
      }
    },
    "lock_state": 0,
    "battery_level": 0,
    "battery_charging": true,
    "offline": true
  }
]

json

application/json

Assign smart lock

POST

/v1/properties/{id}/smartlocks

Attaches either a Nuki smart lock (requires nuki_smartlock_id and nuki_integration_id) or a Unifi smart lock (requires unifi_floor_id and unifi_door_id) to the property.

Assign smart lock › path Parameters

id

string · required

Property id

Assign smart lock › Request Body

AddSmartlockRequest

name

string · required

nuki_smartlock_id

string | null

nuki_integration_id

string | null · uuid

unifi_floor_id

string | null

unifi_door_id

string | null

Assign smart lock › Responses

The created smart lock

SmartLock

id

string · uuid · required

vendor

string · required

name

string · required

property_id

string · uuid · required

lock_state

integer | null

battery_level

integer | null

battery_charging

boolean | null

offline

boolean

POST/v1/properties/{id}/smartlocks

curl /v1/properties/:id/smartlocks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "nuki_smartlock_id": "nuki_smartlock_id",
  "nuki_integration_id": "00000000-0000-0000-0000-000000000000",
  "unifi_floor_id": "unifi_floor_id",
  "unifi_door_id": "unifi_door_id"
}'

Example Request Body

{
  "name": "name",
  "nuki_smartlock_id": "nuki_smartlock_id",
  "nuki_integration_id": "00000000-0000-0000-0000-000000000000",
  "unifi_floor_id": "unifi_floor_id",
  "unifi_door_id": "unifi_door_id"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "vendor": "vendor",
  "name": "name",
  "property_id": "00000000-0000-0000-0000-000000000000",
  "nuki_smartlock": {
    "id": "00000000-0000-0000-0000-000000000000",
    "nuki_smartlock_id": "nuki_smartlock_id"
  },
  "unifi_smartlock": {
    "floor_id": "floor_id",
    "door_id": "door_id",
    "name": "name",
    "assigned_property": {
      "property_id": "00000000-0000-0000-0000-000000000000",
      "property_name": "property_name",
      "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
    }
  },
  "lock_state": 0,
  "battery_level": 0,
  "battery_charging": true,
  "offline": true
}

json

application/json

Remove smart lock

DELETE

/v1/properties/{id}/smartlocks/{smartlockId}

Removes a smart lock from a property.

Remove smart lock › path Parameters

id

string · required

Property id

smartlockId

string · required

Smart lock id

Remove smart lock › Responses

Smart lock removed

No data returned

PropertyMembers Tasks

Kasify API

SmartLocks

List property smart locks

GET

/v1/properties/{id}/smartlocks

Returns every smart lock assigned to the property together with its current lock/battery status fetched from the underlying provider (Nuki or Unifi).

List property smart locks › path Parameters

id

string · required

Property id

List property smart locks › Responses

Smart locks with their live status

SmartLock[]

SmartLock

id

string · uuid · required

vendor

string · required

name

string · required

property_id

string · uuid · required

lock_state

integer | null

battery_level

integer | null

battery_charging

boolean | null

offline

boolean

GET/v1/properties/{id}/smartlocks

curl /v1/properties/:id/smartlocks \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "vendor": "vendor",
    "name": "name",
    "property_id": "00000000-0000-0000-0000-000000000000",
    "nuki_smartlock": {
      "id": "00000000-0000-0000-0000-000000000000",
      "nuki_smartlock_id": "nuki_smartlock_id"
    },
    "unifi_smartlock": {
      "floor_id": "floor_id",
      "door_id": "door_id",
      "name": "name",
      "assigned_property": {
        "property_id": "00000000-0000-0000-0000-000000000000",
        "property_name": "property_name",
        "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
      }
    },
    "lock_state": 0,
    "battery_level": 0,
    "battery_charging": true,
    "offline": true
  }
]

json

application/json

Assign smart lock

POST

/v1/properties/{id}/smartlocks

Attaches either a Nuki smart lock (requires nuki_smartlock_id and nuki_integration_id) or a Unifi smart lock (requires unifi_floor_id and unifi_door_id) to the property.

Assign smart lock › path Parameters

id

string · required

Property id

Assign smart lock › Request Body

AddSmartlockRequest

name

string · required

nuki_smartlock_id

string | null

nuki_integration_id

string | null · uuid

unifi_floor_id

string | null

unifi_door_id

string | null

Assign smart lock › Responses

The created smart lock

SmartLock

id

string · uuid · required

vendor

string · required

name

string · required

property_id

string · uuid · required

lock_state

integer | null

battery_level

integer | null

battery_charging

boolean | null

offline

boolean

POST/v1/properties/{id}/smartlocks

curl /v1/properties/:id/smartlocks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "nuki_smartlock_id": "nuki_smartlock_id",
  "nuki_integration_id": "00000000-0000-0000-0000-000000000000",
  "unifi_floor_id": "unifi_floor_id",
  "unifi_door_id": "unifi_door_id"
}'

Example Request Body

{
  "name": "name",
  "nuki_smartlock_id": "nuki_smartlock_id",
  "nuki_integration_id": "00000000-0000-0000-0000-000000000000",
  "unifi_floor_id": "unifi_floor_id",
  "unifi_door_id": "unifi_door_id"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "vendor": "vendor",
  "name": "name",
  "property_id": "00000000-0000-0000-0000-000000000000",
  "nuki_smartlock": {
    "id": "00000000-0000-0000-0000-000000000000",
    "nuki_smartlock_id": "nuki_smartlock_id"
  },
  "unifi_smartlock": {
    "floor_id": "floor_id",
    "door_id": "door_id",
    "name": "name",
    "assigned_property": {
      "property_id": "00000000-0000-0000-0000-000000000000",
      "property_name": "property_name",
      "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
    }
  },
  "lock_state": 0,
  "battery_level": 0,
  "battery_charging": true,
  "offline": true
}

json

application/json

Remove smart lock

DELETE

/v1/properties/{id}/smartlocks/{smartlockId}

Removes a smart lock from a property.

Remove smart lock › path Parameters

id

string · required

Property id

smartlockId

string · required

Smart lock id

Remove smart lock › Responses

Smart lock removed

No data returned

PropertyMembers Tasks