List Connect Webviews

Returns a list of all Connect Webviews.

POST /connect_webviews/list

JavaScript

Seam SDK

await seam.connectWebviews.list({
  customer_ids: ["e387e15f-be27-47ad-881f-4a6fc5460c57"],
  limit: 50,
});

/*
{
  "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"
}
*/

200

{
  "connect_webviews": [
    {
      "accepted_capabilities": [],
      "accepted_devices": [
        "<string>"
      ],
      "accepted_providers": [
        "<string>"
      ],
      "any_device_allowed": true,
      "any_provider_allowed": true,
      "authorized_at": "2023-11-07T05:31:56Z",
      "automatically_manage_new_devices": true,
      "connect_webview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "custom_metadata": {},
      "custom_redirect_failure_url": "<string>",
      "custom_redirect_url": "<string>",
      "login_successful": true,
      "selected_provider": "<string>",
      "url": "<string>",
      "wait_for_device_creation": true,
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_key": "<string>"
    }
  ],
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

client_sessionclient_session_with_customerpat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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.

Show child attributes

customer_key · string

Customer key for which you want to list connect webviews.

limit · number<float> · default: 500

Maximum number of records to return per page.

page_cursor · string | null

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

search · string

String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using connect_webview_id, accepted_providers, custom_metadata, or customer_key.

Minimum string length: 1

user_identifier_key · string

Your user ID for the user by which you want to filter Connect Webviews.

Response

200

application/json

OK

connect_webviews · object[] · required

Show child attributes

ok · boolean · required

pagination · object · required

Information about the current page of results.

Show child attributes