Skip to main content

​
The connected_account Object

Represents a connected account. A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
A connected account resource.
{
  "account_type": "salto_space",
  "account_type_display_name": "Salto Space",
  "display_name": "j**n@example.com",
  "automatically_manage_new_devices": true,
  "connected_account_id": "a289aa54-5488-4707-9a4b-eeea4edf311d",
  "created_at": "2025-06-15T16:54:17.946329Z",
  "custom_metadata": { "id": "internalId1" },
  "errors": [],
  "user_identifier": {
    "api_url": "https://example.com/api",
    "email": "jane_doe@example.com",
    "exclusive": true,
    "phone": "+1555551004",
    "username": "jane_doe"
  },
  "warnings": [],
  "accepted_capabilities": ["lock"]
}

​
Properties

accepted_capabilities List of Enums List of capabilities that were accepted during the account connection process.
account_type String Type of connected account.
account_type_display_name String Display name for the connected account type.
automatically_manage_new_devices Boolean Indicates whether Seam should import all new devices for the connected account to make these devices available for management by the Seam API.
connected_account_id UUID ID of the connected account.
created_at Datetime Date and time at which the connected account was created.
custom_metadata Record Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.
customer_key String Your unique key for the customer associated with this connected account.
display_name String Display name for the connected account.
errors List of Objects Errors associated with the connected account. The specific structure of each object in this list depends on the value of its error_code field. Variants:
image_url String Logo URL for the connected account provider.
user_identifier Object User identifier associated with the connected account.
Deprecated. Use display_name instead.
warnings List of Objects Warnings associated with the connected account. The specific structure of each object in this list depends on the value of its warning_code field. Variants:

​
Errors

account_disconnected Indicates that the account is disconnected.
bridge_disconnected Indicates that the Seam API cannot communicate with Seam Bridge, for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
salto_ks_subscription_limit_exceeded Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.

​
Warnings

account_reauthorization_requested Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
being_deleted Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.
salto_ks_subscription_limit_almost_reached Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
scheduled_maintenance_window Indicates that scheduled downtime is planned for the connected account.
unknown_issue_with_connected_account Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.

​
Events

connected_account.connected A connected account was connected for the first time or was reconnected after being disconnected.
connected_account.created A connected account was created.
connected_account.successful_login A connected account had a successful login using a Connect Webview.
connected_account.disconnected A connected account was disconnected.
connected_account.completed_first_sync A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
connected_account.deleted A connected account was deleted.
connected_account.completed_first_sync_after_reconnection A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
connected_account.reauthorization_requested A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.

​
Endpoints

/connected_accounts/delete Deletes a specified connected account. /connected_accounts/get Returns a specified connected account. /connected_accounts/list Returns a list of all connected accounts. /connected_accounts/sync Request a connected account sync attempt for the specified connected_account_id. /connected_accounts/update Updates a connected account.