List / search the user's physical keys
Lists physical-key entries for the user. Optional filters: orgId (exact), orgName (exact), q (case-insensitive substring match on note). Filters combine with AND. Capped at 100 entries; total reflects filtered count before the cap.
curl -X GET "https://api.spkey.co/users/example_string/PhysicalKeys?orgId=example_string&orgName=John%20Doe&q=example_string" \
-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/users/example_string/PhysicalKeys?orgId=example_string&orgName=John%20Doe&q=example_string"
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/users/example_string/PhysicalKeys?orgId=example_string&orgName=John%20Doe&q=example_string", {
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/users/example_string/PhysicalKeys?orgId=example_string&orgName=John%20Doe&q=example_string", 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/users/example_string/PhysicalKeys?orgId=example_string&orgName=John%20Doe&q=example_string')
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
{
"keys": [
{
"number": 42,
"orgId": "example_string",
"orgName": "John Doe",
"note": "example_string",
"addedAt": 3.14
}
],
"total": 42
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/users/{id}/PhysicalKeysTarget 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.
User ID
Filter by exact orgId match
Filter by exact orgName match
Case-insensitive substring match against the note field
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.
Path Parameters
User ID
Query Parameters
Filter by exact orgId match
Filter by exact orgName match
Case-insensitive substring match against the note field
Responses
Filtered count BEFORE the 100-result cap