8kitInstall

Summary

Check a lock by its unique key.

Inputs

• key (required) — Unique identifier for the lock. Must contain only letters, numbers, hyphens, and underscores. Maximum 255 characters.
• getLockData — Whether to include lock details in the output.
• lockDataFieldName — The field name where lock data will be stored in the output JSON. Only applicable when getLockData is true.

Output shape

object

Returns lock status. If getLockData is true, lock data is stored under the specified lockDataFieldName key.

Examples

Example 1: Check lock existence and retrieve data

Set key to a valid lock identifier, enable getLockData, and optionally customize lockDataFieldName.