List temporary keys for lock
Returns all temporary keys for the lock with computed status (valid, expired, used-up, not-yet-valid).
curl -X GET "https://api.spkey.co/locks/123/temp-keys" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY"
import requests
import json
url = "https://api.spkey.co/locks/123/temp-keys"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.spkey.co/locks/123/temp-keys", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.spkey.co/locks/123/temp-keys", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/locks/123/temp-keys')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"tempKeys": [
{
"uuid": "example_string",
"lockId": 3.14,
"lockUuid": "example_string",
"accessMode": "public",
"allowedUserIds": [
"example_string"
],
"validFrom": "example_string",
"validUntil": "example_string",
"maxUses": "null",
"usedCount": 3.14,
"createdAt": "example_string",
"createdBy": "example_string",
"status": "valid"
}
]
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
GET
/locks/{id}/temp-keysGET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredJWT 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
RequiredAPI key for B2B organization access. Provided during organization onboarding.
API key for B2B organization access. Provided during organization onboarding.
path
idinteger
RequiredLock ID (numeric)
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
header
X-API-Keystring
RequiredAPI Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
idinteger
RequiredLock ID (numeric)
Responses
tempKeysarray
Requireduuidstring
RequiredlockIdnumber
RequiredlockUuidstring
RequiredaccessModestring
RequiredAllowed values:
publicuser-whitelistallowedUserIdsstring[]
RequiredvalidFromstring
RequiredvalidUntilstring
RequiredmaxUsesnumber,null
RequiredusedCountnumber
RequiredcreatedAtstring
RequiredcreatedBystring
Requiredstatusstring
RequiredAllowed values:
validexpiredused-upnot-yet-validerrorstring
Requiredmessagestring
RequiredWas this page helpful?