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
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
Response
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
Sample Response
Last updated