{
"instant_key": {
"client_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"instant_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instant_key_url": "<string>",
"user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customization": {
"logo_url": "<string>",
"primary_color": "<string>",
"secondary_color": "<string>"
},
"customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Instant Keys
Get an Instant Key
Gets an instant key.
You must include at least one request parameter.
GET
/
instant_keys
/
get
{
"instant_key": {
"client_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"instant_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instant_key_url": "<string>",
"user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customization": {
"logo_url": "<string>",
"primary_color": "<string>",
"secondary_color": "<string>"
},
"customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
client_sessionapi_keypat_with_workspaceconsole_session_with_workspacesupport_read_only_token
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
ID of the instant key to get.
URL of the instant key to get.
Response
OK
Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app. See the instant_key object.
Show child attributes
Show child attributes
Was this page helpful?