The Connected Account Object

Learn how the connected_account object represents an external third-party account your user has authorized Seam to access, such as an August account.

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.

Connected Account

{
  "account_type": "salto_space",
  "account_type_display_name": "Salto Space",
  "display_name": "j**[e-mail]",
  "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": "[e-mail]",
    "exclusive": true,
    "phone": "[phone]",
    "username": "jane_doe"
  },
  "warnings": [],
  "accepted_capabilities": [
    "lock"
  ]
}

---

Properties

accepted_capabilities · Array

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 · String (UUID)

ID of the connected account.

created_at · String (ISO 8601)

Date and time at which the connected account was created.

custom_metadata · object

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.

default_checkin_time · 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.

default_checkout_time · String

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

display_name · String

Display name for the connected account.

errors · Array

Errors associated with the connected account.

ical_feed_origin · 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.

ical_url · String

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

image_url · String

Logo URL for the connected account provider.

time_zone · String

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

user_identifier · Object · deprecated

User identifier associated with the connected account.

Show properties

api_url · String

API URL for the user identifier associated with the connected account.

email · String

Email address of the user identifier associated with the connected account.

exclusive · Boolean

Indicates whether the user identifier associated with the connected account is exclusive.

phone · String

Phone number of the user identifier associated with the connected account.

username · String

Username of the user identifier associated with the connected account.

warnings · Array

Warnings associated with the connected account.