---
title: "Get a Connect Webview"
method: POST
path: "/connect_webviews/get"
tags: ["/connect_webviews"]
---

# Get a Connect Webview

`POST /connect_webviews/get`

Returns a specified [Connect Webview](/core-concepts/connect-webviews).

Unless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.

## Request body

- object
  - `connect_webview_id` string, uuid, required — ID of the Connect Webview that you want to get.

## Response `200`

OK

- object
  - `connect_webview` ConnectWebview, required — Represents a [Connect Webview](/core-concepts/connect-webviews). See the [connect_webview object](/api/connect_webviews/object).
    - `accepted_capabilities` string[], required — High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.
    - `accepted_providers` string[], required — List of accepted [provider keys](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
    - `any_provider_allowed` boolean, required — Indicates whether any provider is allowed.
    - `authorized_at` string, date-time, nullable, required — Date and time at which the user authorized (through the Connect Webview) the management of their devices.
    - `automatically_manage_new_devices` boolean, required — Indicates whether Seam should [import all new devices](/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.
    - `connect_webview_id` string, uuid, required — ID of the Connect Webview.
    - `connected_account_id` string, uuid, nullable, required — ID of the connected account associated with the Connect Webview.
    - `created_at` string, date-time, required — Date and time at which the Connect Webview was created.
    - `custom_metadata` object, required — Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
    - `custom_redirect_failure_url` string, uri, nullable, required — URL to which the Connect Webview should redirect when an unexpected error occurs.
    - `custom_redirect_url` string, uri, nullable, required — URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.
    - `customer_key` string — The customer key associated with this webview, if any.
    - `device_selection_mode` 'none' | 'single' | 'multiple', required — Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.
    - `login_successful` boolean, required — Indicates whether the user logged in successfully using the Connect Webview.
    - `selected_provider` string, nullable, required — Selected provider of the Connect Webview, one of the [provider keys](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
    - `status` 'pending' | 'failed' | 'authorized', required — Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.
    - `url` string, uri, required — URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.
    - `wait_for_device_creation` boolean, required — Indicates whether Seam should [finish syncing all devices](/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.
    - `workspace_id` string, uuid, required — ID of the workspace that contains the Connect Webview.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/seam/apis/seam-connect.md) · [All operations](https://skmtc.net/seam/apis/seam-connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seam/seam-connect/versions/00c35395ce12/schema)