List Connected Accounts

Get all Connected accounts

Returns a list of all connected accounts (connected_account objects).

Request

To filter the list of returned connected accounts by a specific set of custom metadata, include custom_metadata_has in the request body. If you include custom_metadata_has, specify the desired metadata filters as a JSON object containing key:value pairs.

Request Body Parameters

ParameterTypeDescription

custom_metadata_has

JSON object Optional

Set of key:value custom metadata pairs by which you want to filter connected accounts For more information, see Adding Custom Metadata to Connected Accounts.

Sample Request

connected_accounts = seam.connected_accounts.list()

Response

Returns a connected_accounts array, in which each returned connected account (connected_account) contains the following properties:

PropertyDescription

connected_account_id

ID of the connected account

created_at

Date and time at which the connected account was created

user_identifier

Unique identifier for the connected account, such as an email address or phone number

account_type

Type of manufacturer to which the connected account belongs, such as august, schlage, yale, salto, smartthings, and so on

account_type_display_name

Version of account_type that can be displayed in a user interface

custom_metadata

Set of custom_metadata set on the Connect Webview that connected the account. You can also modify or add to this custom_metadata.

automatically_manage_new_devices

Indicates whether Seam should import all new devices for the connected account to make these devices available for use and management by the Seam API. You initially specify the value for this property when creating the corresponding Connect Webview.

This response also includes a Boolean ok status indicator.

Sample Response

{
  "connected_accounts": [
    {
      "connected_account_id": "c993818b-bf3c-4836-bef4-9a76d89bf1d3",
      "created_at": "2024-01-05T07:20:07.692Z",
      "user_identifier": {
        "username": "jane"
      },
      "account_type": "visionline",
      "account_type_display_name": "Visionline",
      "errors": [],
      "warnings": [],
      "custom_metadata": {
          "internal_account_id": "user-1"
      },
      "automatically_manage_new_devices": true
    },
	...
  ],
  "ok": true
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.