Get basic lock info
Get basic lock information without keys and residents
curl -X GET "https://api.spkey.co/locks/123/basic-info" \
-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/basic-info"
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/basic-info", {
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/basic-info", 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/basic-info')
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
{
"id": "example_string",
"lockId": 3.14,
"uuid": "example_string",
"version": 3.14,
"serialNumber": "example_string",
"ownerId": "example_string",
"orgId": "example_string",
"organizationId": "example_string",
"doId": "example_string",
"r2Prefix": "example_string"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
GET
/locks/{id}/basic-infoGET
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
idstring
RequiredlockIdnumber
Requireduuidstring
Requiredversionnumber
RequiredserialNumberstring
ownerIdstring
orgIdstring
organizationIdstring
doIdstring
Durable Object hex id for direct DO lookup and debugging
r2Prefixstring
RequiredR2 key prefix where this lock's events are stored
successboolean
Requirederrorsarray
Requiredcodenumber
Requiredmessagestring
RequiredWas this page helpful?