List Connect Webviews
Returns a list of all Connect Webviews.
Returns a list of all Connect Webviews for a specified customer ID.
Code
await seam.connectWebviews.list({
customer_ids: ["e387e15f-be27-47ad-881f-4a6fc5460c57"],
limit: 50,
});
Output
{
"accepted_capabilities": ["lock", "thermostat"],
"accepted_devices": [],
"accepted_providers": ["kwikset", "schlage", "smartthings", "yale"],
"any_device_allowed": true,
"any_provider_allowed": false,
"authorized_at": null,
"automatically_manage_new_devices": true,
"connect_webview_id": "c4c30885-ec87-4b31-8d7b-9bc0678fa028",
"connected_account_id": null,
"created_at": "2025-06-14T16:54:17.946323Z",
"custom_metadata": { "id": "internalId1" },
"custom_redirect_failure_url": "https://example.com/failure-redirect",
"custom_redirect_url": "https://example.com/redirect",
"device_selection_mode": "none",
"login_successful": false,
"selected_provider": null,
"status": "pending",
"url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d",
"wait_for_device_creation": true,
"workspace_id": "9db95105-e77d-4577-b1b7-0a20b360d5e0"
}
Request Parameters
custom_metadata_has
Object
Custom metadata pairs by which you want to filter Connect Webviews. Returns Connect Webviews with custom_metadata
that contains all of the provided key:value pairs.
customer_ids
Array of Strings
limit
Number
Maximum number of records to return per page.
page_cursor
String
Identifies the specific page of results to return, obtained from the previous page's next_page_cursor
.
user_identifier_key
String
Your user ID for the user by which you want to filter Connect Webviews.
Response
Array of connect_webviews
{
"accepted_capabilities": ["lock", "thermostat"],
"accepted_devices": [],
"accepted_providers": ["schlage", "kwikset", "yale", "smartthings"],
"any_device_allowed": false,
"any_provider_allowed": false,
"authorized_at": "2025-06-14T16:54:17.946323Z",
"automatically_manage_new_devices": true,
"connect_webview_id": "c4c30885-ec87-4b31-8d7b-9bc0678fa028",
"connected_account_id": "5d2fe05f-4f5b-4b91-909c-96e2601dccbe",
"created_at": "2025-06-14T16:54:17.946323Z",
"custom_metadata": { "id": "internalId1" },
"custom_redirect_failure_url": "https://example.com/failure-redirect",
"custom_redirect_url": "https://example.com/redirect",
"device_selection_mode": "single",
"login_successful": true,
"selected_provider": "schlage",
"status": "authorized",
"url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=2r2Rn8V5QUtxE79gNsTmLK58KkuqrwU8d",
"wait_for_device_creation": true,
"workspace_id": "9db95105-e77d-4577-b1b7-0a20b360d5e0"
}
Examples
List Connect Webviews for a user identifier key
Returns a list of all Connect Webviews for a specified user identifier key.
Code
await seam.connectWebviews.list({
user_identifier_key: "7bf74090-25cc-4235-a2f8-aea277b19597",
limit: 50,
});
Output
{
"accepted_capabilities": ["lock", "thermostat"],
"accepted_devices": [],
"accepted_providers": ["kwikset", "schlage", "smartthings", "yale"],
"any_device_allowed": true,
"any_provider_allowed": false,
"authorized_at": null,
"automatically_manage_new_devices": true,
"connect_webview_id": "c4c30885-ec87-4b31-8d7b-9bc0678fa028",
"connected_account_id": null,
"created_at": "2025-06-14T16:54:17.946323Z",
"custom_metadata": { "id": "internalId1" },
"custom_redirect_failure_url": "https://example.com/failure-redirect",
"custom_redirect_url": "https://example.com/redirect",
"device_selection_mode": "none",
"login_successful": false,
"selected_provider": null,
"status": "pending",
"url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d",
"wait_for_device_creation": true,
"workspace_id": "9db95105-e77d-4577-b1b7-0a20b360d5e0"
}
List Connect Webviews with specific custom metadata
Returns a list of all Connect Webviews containing specified custom metadata.
Code
await seam.connectWebviews.list({
custom_metadata_has: { id: "internalId1" },
limit: 50,
});
Output
{
"accepted_capabilities": ["lock", "thermostat"],
"accepted_devices": [],
"accepted_providers": ["kwikset", "schlage", "smartthings", "yale"],
"any_device_allowed": true,
"any_provider_allowed": false,
"authorized_at": null,
"automatically_manage_new_devices": true,
"connect_webview_id": "c4c30885-ec87-4b31-8d7b-9bc0678fa028",
"connected_account_id": null,
"created_at": "2025-06-14T16:54:17.946323Z",
"custom_metadata": { "id": "internalId1" },
"custom_redirect_failure_url": "https://example.com/failure-redirect",
"custom_redirect_url": "https://example.com/redirect",
"device_selection_mode": "none",
"login_successful": false,
"selected_provider": null,
"status": "pending",
"url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d",
"wait_for_device_creation": true,
"workspace_id": "9db95105-e77d-4577-b1b7-0a20b360d5e0"
}
Last updated
Was this helpful?