Connected Accounts
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**[email protected]",
"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": "[email protected]",
"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:
account_disconnected
Indicates that the account is disconnected.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
account_disconnected
is_bridge_error Boolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_error Boolean
Indicates whether the error is related specifically to the connected account.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
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.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
bridge_disconnected
is_bridge_error Boolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_error Boolean
Indicates whether the error is related specifically to the connected account.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
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.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_exceeded
is_bridge_error Boolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_error Boolean
Indicates whether the error is related specifically to the connected account.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
salto_ks_metadata Object
Salto KS metadata associated with the connected account that has an error.
Child Properties
sitesList of ObjectsSalto sites associated with the connected account that has an error.
site_idStringID of a Salto site associated with the connected account that has an error.
site_nameStringName of a Salto site associated with the connected account that has an error.
site_user_subscription_limitNumberSubscription limit of site users for a Salto site associated with the connected account that has an error.
subscribed_site_user_countNumberCount of subscribed site users for a Salto site associated with the connected account that has an error.
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.
Child Properties
api_urlStringAPI URL for the user identifier associated with the connected account.
emailStringEmail address of the user identifier associated with the connected account.
exclusiveBooleanIndicates whether the user identifier associated with the connected account is exclusive.
phoneStringPhone number of the user identifier associated with the connected account.
usernameStringUsername of the user identifier associated with the connected account.
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:
scheduled_maintenance_window
Indicates that scheduled downtime is planned for the connected account.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
scheduled_maintenance_window
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.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
unknown_issue_with_connected_account
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.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
salto_ks_metadata Object
Salto KS metadata associated with the connected account that has a warning.
Child Properties
sitesList of ObjectsSalto sites associated with the connected account that has a warning.
site_idStringID of a Salto site associated with the connected account that has a warning.
site_nameStringName of a Salto site associated with the connected account that has a warning.
site_user_subscription_limitNumberSubscription limit of site users for a Salto site associated with the connected account that has a warning.
subscribed_site_user_countNumberCount of subscribed site users for a Salto site associated with the connected account that has a warning.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_almost_reached
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.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
account_reauthorization_requested
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.
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.
Properties
connect_webview_id UUID
ID of the Connect Webview associated with the event.
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
customer_key String
The customer key associated with this connected account, if any.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.connected
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
connected_account.created
A connected account was created.
Properties
connect_webview_id UUID
ID of the Connect Webview associated with the event.
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.created
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
connected_account.successful_login
A connected account had a successful login using a Connect Webview.
Properties
connect_webview_id UUID
ID of the Connect Webview associated with the event.
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.successful_login
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
connected_account.disconnected
A connected account was disconnected.
Properties
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_errors List of Objects
Errors associated with the connected account.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.disconnected
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
connected_account.completed_first_sync
A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
Properties
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.completed_first_sync
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
connected_account.deleted
A connected account was deleted.
Properties
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
connected_account_type String
undocumented: Unreleased.
created_at Datetime
Date and time at which the event was created.
customer_key String
The customer key associated with this connected account, if any.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.deleted
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
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.
Properties
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.completed_first_sync_after_reconnection
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
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.
Properties
connected_account_custom_metadata Record
Custom metadata of the connected account, present when connected_account_id is provided.
connected_account_id UUID
ID of the affected connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: connected_account.reauthorization_requested
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
Deletes a specified connected account.
Returns a specified connected account.
Returns a list of all connected accounts.
Request a connected account sync attempt for the specified connected_account_id.
Updates a connected account.
Last updated
Was this helpful?