<resource>_key property in which you can store your own identifier. For example:
space_keyfor Spacesuser_identity_keyfor User Identitiesaccess_grant_keyfor Access Grantscustomer_keyfor Connect Webviews and Connected Accounts
space_key room-101-id, you cannot create another Space with this key.
The one exception is with customer_key, where you can create multiple Connect Webviews using the same customer_key.
The guide describes how to add resources keys to Seam resources of various relevant types and also how to retrieve a Seam resource using a resource key.
Associating Connected Accounts with Your Customers
Connected Accounts represent connections that your customers set up with their own devices or access systems through your app. You embed a Connect Webview in your app, and your customers establish these connections by authenticating their device or system accounts through the pre-built Connect Webview flow. Each successful connection creates a Connected Account in your Seam workspace. Each Connected Account is linked to a specific customer. When you create an instance of a Connect Webview, you can tag it with a customer key. When your customer completes the authentication flow through this Connect Webview, Seam automatically copies thecustomer_key to the resulting Connected Account. You can then use the customer_key to retrieve the Connected Account consistently.
Create a Connect Webview for a Specific Customer
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:
Retrieve All Connected Accounts for a Specific Customer
Once your customer has completed the Connect Webview authentication flow, and Seam has copied thecustomer_key to the resulting Connected Account, you can list all Connected Accounts associated with a specific customer_key tag. Then, you can also list all devices or systems associated with the customer, using the retrieved Connected Account ID.
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:
customer_key, so you can associate their connected systems with their properties, Spaces, and reservations in your own database.
Associating a Seam Space with Your Own Resource
When you create a Seam space resource, you can include your own ID as the value for thespace_key. Some examples of resources that you could tie to a Space include hotel rooms, apartments, or common area amenities.
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:
Associating a Seam User Identity with Your User
You can use theuser_identity_key to link a Seam User Identity with your ID for a user, such as a hotel guest, resident, and so on.
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:
Associating a Seam Access Grant with Your Own Resource
You can add your own booking or lease reference to a Seam Access Grant as anaccess_grant_key. Some examples of resources that you could tie to an Access Grant include a guest booking, apartment lease, or gym day pass.
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:
Retrieving a Resource Using the <resource>_key
Once you have linked your resources to Seam resources using resource keys, you can retrieve a Seam resource using your custom unique identifier for it.
The following example retrieves a Seam Space using a space_key:
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:
access_grant_key:
- JavaScript
- cURL
- Python
- Ruby
- PHP
- C#
Code:Output:

