The Connected Account Object

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.

{
  "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

Array of Enums (String)

required

List of capabilities that were accepted during the account connection process.

Enum values

lock
thermostat
noise_sensor
access_control
camera
speaker
pool

String

Type of connected account.

String

required

Display name for the connected account type.

Boolean

required

Indicates whether Seam should import all new devices for the connected account to make these devices available for management by the Seam API.

String (UUID)

required

ID of the connected account.

String (ISO 8601)

Date and time at which the connected account was created.

Object (String, Boolean values)

required

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. Keys set to null or to an empty string are omitted.

String

Your unique key for the customer associated with this connected account.

String

Default reservation check-in time for this connected account, as HH:mm (24-hour). Sourced from the connector configuration — set during the connect_webview for providers like Lodgify whose API does not expose check-in times.

String

Default reservation check-out time for this connected account, as HH:mm (24-hour). Sourced from the connector configuration.

String

required

Display name for the connected account.

Array of Objects

required

Errors associated with the connected account.

Show properties

Enum (String)

required

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values

account_disconnected
bridge_disconnected
salto_ks_subscription_limit_exceeded
dormakaba_sites_disconnected

String

required

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

String (ISO 8601)

required

Date and time at which Seam created the error.

Boolean

Indicates whether the error is related to Seam Bridge.

Boolean

Indicates whether the error is related specifically to the connected account.

String

For iCal connected accounts, the platform that produced the feed (for example, airbnb, vrbo, or booking), or unknown when it could not be determined. Intended for rendering the source platform’s logo.

String

For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.

String

Logo URL for the connected account provider.

String

IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.

Array of Objects

required

Warnings associated with the connected account.

Show properties

Enum (String)

required

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
salto_ks_subscription_limit_almost_reached
account_reauthorization_requested
being_deleted
provider_service_unavailable
setup_required
dormakaba_sites_unapproved

String

required

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

String (ISO 8601)

required

Date and time at which Seam created the warning.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The Connected Account Object

The connected_account Object

Properties