LockGet lock details

Get lock details

Get full lock details including keys and residents

curl -X GET "https://api.spkey.co/locks/123/details" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "id": "example_string",
  "lockId": 3.14,
  "uuid": "example_string",
  "serialNumber": "example_string",
  "keys": [
    {
      "uuid": "example_string",
      "indexNumber": 3.14,
      "userId": "example_string"
    }
  ],
  "ownerId": "example_string",
  "organizationId": "example_string",
  "residents": [
    {
      "userId": "example_string",
      "name": "John Doe",
      "email": "user@example.com"
    }
  ],
  "orgId": "example_string",
  "version": 3.14,
  "timestamp": "example_string",
  "doId": "example_string",
  "r2Prefix": "example_string"
}
GET
/locks/{id}/details
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
path
idinteger
Required

Lock ID (numeric)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

idinteger
Required

Lock ID (numeric)

Responses

idstring
Required
lockIdnumber
Required
uuidstring
Required
serialNumberstring
keysarray
Required
ownerIdstring
organizationIdstring
residentsarray
Required
orgIdstring
Required
versionnumber
Required
timestampstring
Required
doIdstring

Durable Object hex id for direct DO lookup and debugging

r2Prefixstring
Required

R2 key prefix where this lock's events are stored