Sign in
Locks

Fetch locks

Returns a list of locks.

When authenticating with a GroupLink, a subset of the Lock resource is returned.

get/locks

Query parameters

idsstring

Filter by object IDs

querystring

Filter by a freetext string. Properties searched: name

floor_idinteger

Filter by floor ID

place_idinteger

Filter by place ID

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

configuredboolean

Filter by whether the lock has been configured.

onlineboolean

Filter by whether the lock is online.

unlockedboolean

Filter by whether the lock is unlocked or locked.

locked_downboolean

Filter by whether the lock is locked down.

favorite'true' | 'false' | '*'

Include favorite status in response and/or filter by it.

* - include favorite field in response<br> true - include favorite field in response and return favorites<br> false - include favorite field in response and return non-favorites<br>

sort'favorite' | 'name' | '-name'

Sort the results. Prepend - to sort in reverse order.

favorite - sort by favorite, most recent favorites first<br> name - sort by lock name, alphabetically

Response

OK

Example response

[
  {
    "time_restriction_time_zone": "Europe/London"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.