TempKeyList temporary access keys

List temporary access keys

Lists unified temp keys. With ?lockId= returns every key touching that lock (requires authorization for the lock); without a filter returns the keys created by the caller.

curl -X GET "https://api.spkey.co/temp-keys?lockId=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "tempKeys": [
    {
      "uuid": "example_string",
      "url": "example_string",
      "validFrom": "example_string",
      "validUntil": "example_string",
      "description": "null",
      "createdBy": "example_string",
      "createdAt": "example_string",
      "revokedAt": "null",
      "doors": [
        {
          "id": 3.14,
          "lockId": "example_string",
          "lockUuid": "example_string",
          "label": "null",
          "accessMethod": "key"
        }
      ]
    }
  ]
}
GET
/temp-keys
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
lockIdstring

Filter to keys touching this lock (caller must be authorized for it)

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.

Query Parameters

lockIdstring

Filter to keys touching this lock (caller must be authorized for it)

Responses

tempKeysarray
Required