---
title: "List Connected Accounts"
method: POST
path: "/connected_accounts/list"
tags: ["/connected_accounts"]
---

# List Connected Accounts

`POST /connected_accounts/list`

Returns a list of all [connected accounts](/core-concepts/connected-accounts).

## Request body

- object
  - `custom_metadata_has` object — Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.
  - `customer_key` string — Customer key by which you want to filter connected accounts.
  - `limit` integer — Maximum number of records to return per page.
  - `page_cursor` string, nullable — 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 connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`.
  - `space_id` string, uuid — ID of the space by which you want to filter connected accounts.
  - `user_identifier_key` string — Your user ID for the user by which you want to filter connected accounts.

## Response `200`

OK

- object
  - `connected_accounts` ConnectedAccount[], required
    - `accepted_capabilities` string[], required — List of capabilities that were accepted during the account connection process.
    - `account_type` string — Type of connected account.
    - `account_type_display_name` string, required — Display name for the connected account type.
    - `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 management by the Seam API.
    - `connected_account_id` string, uuid, required — ID of the connected account.
    - `created_at` string, date-time — Date and time at which the connected account 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.
    - `customer_key` string — Your unique key for the customer associated with this connected account.
    - `default_checkin_time` string — Default reservation check-in time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration — set during the connect_webview for providers like Lodgify whose API does not expose check-in times.
    - `default_checkout_time` string — Default reservation check-out time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration.
    - `display_name` string, required — Display name for the connected account.
    - `errors` union[], required — Errors associated with the connected account.
      - union
        - object — Indicates that the account is disconnected.
          - `created_at` string, date-time, required — Date and time at which Seam created the error.
          - `error_code` 'account_disconnected', required — Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          - `is_bridge_error` boolean — Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).
          - `is_connected_account_error` boolean — Indicates whether the error is related specifically to the connected account.
          - `message` string, required — Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
        - object — Indicates that the Seam API cannot communicate with [Seam Bridge](/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
          - `created_at` string, date-time, required — Date and time at which Seam created the error.
          - `error_code` 'bridge_disconnected', required — Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          - `is_bridge_error` boolean — Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).
          - `is_connected_account_error` boolean — Indicates whether the error is related specifically to the connected account.
          - `message` string, required — Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
        - object — Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
          - `created_at` string, date-time, required — Date and time at which Seam created the error.
          - `error_code` 'salto_ks_subscription_limit_exceeded', required — Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          - `is_bridge_error` boolean — Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).
          - `is_connected_account_error` boolean — Indicates whether the error is related specifically to the connected account.
          - `message` string, required — Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
          - `salto_ks_metadata` object, required — Salto KS metadata associated with the connected account that has an error.
            - `sites` object[] — Salto sites associated with the connected account that has an error.
              - …
        - object — Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
          - `created_at` string, date-time, required — Date and time at which Seam created the error.
          - `error_code` 'dormakaba_sites_disconnected', required — Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          - `is_bridge_error` boolean — Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).
          - `is_connected_account_error` boolean — Indicates whether the error is related specifically to the connected account.
          - `message` string, required — Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
    - `ical_feed_origin` string — For iCal connected accounts, the platform that produced the feed (for example, `airbnb`, `vrbo`, or `booking`), or `unknown` when it could not be determined. Intended for rendering the source platform's logo.
    - `ical_url` string — For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.
    - `image_url` string, uri — Logo URL for the connected account provider.
    - `time_zone` string — IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.
    - `user_identifier` object — Deprecated. Use `display_name` instead. User identifier associated with the connected account.
      - `api_url` string — API URL for the user identifier associated with the connected account.
      - `email` string — Email address of the user identifier associated with the connected account.
      - `exclusive` boolean — Indicates whether the user identifier associated with the connected account is exclusive.
      - `phone` string — Phone number of the user identifier associated with the connected account.
      - `username` string — Username of the user identifier associated with the connected account.
    - `warnings` object[], required — Warnings associated with the connected account.
      - `error_code` string — Error or warning code.
      - `message` string — Human-readable description.
      - `created_at` string, date-time — When this error or warning was generated.
  - `pagination` Pagination, required — Information about the current page of results.
    - `has_next_page` boolean, required — Indicates whether there is another page of results after this one.
    - `next_page_cursor` string, nullable, required — Opaque value that can be used to select the next page of results via the `page_cursor` parameter.
    - `next_page_url` string, uri, nullable, required — URL to get the next page of results.

## 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)