QueryGet a single physical key by number

Get a single physical key by number

Returns the user's physical-key entry with the given number, or 404 if no such entry exists.

curl -X GET "https://api.spkey.co/users/example_string/PhysicalKeys/42?_callerOrgId=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "number": 42,
  "orgId": "example_string",
  "orgName": "John Doe",
  "note": "example_string",
  "addedAt": 3.14
}
GET
/users/{id}/PhysicalKeys/{number}
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.
query
_callerOrgIdstring

Server-set: caller org id from API-key auth. Clients MUST NOT supply this.

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

numberinteger
Required

Physical key number

Query Parameters

_callerOrgIdstring

Server-set: caller org id from API-key auth. Clients MUST NOT supply this.

Responses

numberinteger
Required
orgIdstring
Required
orgNamestring
notestring
addedAtnumber
Required