List Connect Webviews
List all Connect Webviews
Last updated
Was this helpful?
List all Connect Webviews
Last updated
Was this helpful?
Returns a list of all Connect Webviews.
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.
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
Returns a connect_webviews
array, in which each returned connect_webview
contains the following properties:
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
Set of key:value pairs by which you want to filter Connect Webviews.
ID of the that was created after the user successfully logged in
ID of the that contains the Connect Webview
List of accepted
List of accepted
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 .
Indicates whether Seam should for the connected account to make these devices available for use and management by the Seam API
Indicates whether Seam should in a newly-connected account before completing the associated Connect Webview
Selected provider of the Connec Webview, one of
/connect_webviews/list
Returns webviews that can be accessed by the provided user_identifier_key.
Returns webviews whose custom_metadata contains all of the provided key/value pairs.