QueryGet the user's call-to-open choice

Get the user's call-to-open choice

Returns the locks or Matter devices chosen to open when the user calls the call-to-open number: targets, each with the digit that picks it, ordered by digit; kind and id name the one on the lowest digit; with chosenAt and chosenBy.kind. choice: null when none is chosen. A user reads only their own choice; any partner API key may read any user's. A preference, not an access grant.

curl -X GET "https://api.spkey.co/users/example_string/call-to-open-lock" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "userId": "example_string",
  "choice": "null"
}
GET
/users/{id}/call-to-open-lock
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.
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

Responses

userIdstring
Required
choiceobject,null
Required

The current call-to-open choice, or null when none is chosen