List Door Lock PIN provisioning status across the fleet
Joins device_pin_capability with matter_device_app_pin for every known Matter Door Lock, newest activity first. Filter by provisionState to answer "which locks are unconfirmed or failed?", or by requirePinRemote to find locks the app-PIN gate does or does not apply to. Locks that have never provisioned are included (campaign null) unless a state filter excludes them. The stored PIN is never returned. Requires dual auth.
curl -X GET "https://api.spkey.co/admin/pin-status?provisionState=pending&requirePinRemote=true&limit=42" \
-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/admin/pin-status?provisionState=pending&requirePinRemote=true&limit=42"
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/admin/pin-status?provisionState=pending&requirePinRemote=true&limit=42", {
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/admin/pin-status?provisionState=pending&requirePinRemote=true&limit=42", 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/admin/pin-status?provisionState=pending&requirePinRemote=true&limit=42')
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
{
"total": 3.14,
"truncated": true,
"rows": [
{
"thingName": "John Doe",
"capability": "null",
"campaign": "null"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/admin/pin-status
Target server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
Filter to campaigns in this state. Omit for all.
Filter on the tri-state gate: positively required, positively not, or never reported.
Max rows to return (default 100).
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Query Parameters
Filter to campaigns in this state. Omit for all.
pendingsentverifiedunverifiedfailedFilter on the tri-state gate: positively required, positively not, or never reported.
truefalseunknownMax rows to return (default 100).