List Connect Webviews

List all Connect Webviews

Returns a list of all Connect Webviews.

Request

To filter the list of returned Connect Webviews by a specific set of custom metadata or a user identifier key, include custom_metadata_has or user_identifier_key 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

user_identifier_key

String Optional

The internal user ID (your own internal ID for a user) by which you want to filter Connect Webviews

custom_metadata_has

JSON object Optional

Set of key:value custom metadata pairs by which you want to filter Connect Webviews

Sample Request

connect_webviews = seam.connect_webviews.list()

Response

Returns a connect_webviews array, in which each returned Connect Webview (connect_webview) contains the following properties:

PropertyDescription

connect_webview_id

ID of the Connect Webview

connected_account_id

ID of the connected account that was created after the user successfully logged in

url

URL for the Connect Webview

workspace_id

ID of the workspace that contains the Connect Webview

device_selection_mode

Device selection mode, including none, single, or multiple

accepted_providers

List of accepted device provider keys

accepted_devices

List of accepted devices

any_provider_allowed

Indicates whether any provider is allowed

any_device_allowed

Indicates whether any device is allowed

created_at

Date and time at which the Connect Webview was created

login_successful

Indicates whether the user logged in successfully using the Connect Webview

status

Status of the Connect Webview, including pending or authorized

custom_redirect_url

If set, the Connect Webview redirects to this URL when the user successfully pairs a device or, if the custom_redirect_failure_url is not set, when an unexpected error occurs

custom_redirect_failure_url

If set, the Connect Webview redirects to this URL when an unexpected error occurs

custom_metadata

Set of up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters For more information, see Attaching Custom Data to the Connect Webview.

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

wait_for_device_creation

Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview

authorized_at

Date and time at which the user authorized (through the Connect Webview) the management of their devices

selected_provider

Selected provider of the Connec Webview, one of device provider keys

This response also includes a Boolean ok status indicator.

Sample Response

{
  "connect_webviews": [
    {
      "connect_webview_id": "2a4a0a19-4936-4379-8770-7cf74f87e7b1",
      "url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=2a4a0a19-4936-4379-8770-7cf74f87e7b1&auth_token=NhbgghSPXPeXd7wZYVPxQKksR1eoxam8N",
      "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
      "device_selection_mode": "none",
      "accepted_providers": [
        "august",
        "brivo",
        "schlage",
        "yale",
      ],
      "selected_provider": "august",
      "accepted_devices": [],
      "any_provider_allowed": false,
      "any_device_allowed": false,
      "created_at": "2023-12-15T06:23:32.780Z",
      "login_successful": true,
      "authorized_at": "2023-12-15T06:23:55.024Z",
      "status": "authorized",
      "custom_metadata": {
          "internal_account_id": "user-1"
      },
      "custom_redirect_url": null,
      "wait_for_device_creation": false,
      "custom_redirect_failure_url": null,
      "automatically_manage_new_devices": true,
      "connected_account_id": "f891acfd-d228-4bb2-8399-c0f7e24e6b16"
    },
    ...
  ],
  "ok": true
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.