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

Parameter
Type
Description

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

Sample Request

connect_webviews = seam.connect_webviews.list()

Response

Returns a connect_webviews array, in which each returned connect_webview contains the following properties:

Property
Description

connect_webview_id

ID of the Connect Webview

connected_account_id

url

URL for the Connect Webview

workspace_id

device_selection_mode

Device selection mode, including none, single, or multiple

accepted_providers

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

automatically_manage_new_devices

wait_for_device_creation

authorized_at

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

selected_provider

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.