List Connected Accounts

Returns a list of all connected accounts.

POST /connected_accounts/list

JavaScript

Seam SDK

await seam.connectedAccounts.list({ user_identifier_key: "2f393937-1405-4b1a-933f-34c97bfb3c56", limit: 50, }); /* [ { "account_type": "salto_space", "account_type_display_name": "Salto Space", "display_name": "j**[e-mail]", "automatically_manage_new_devices": true, "connected_account_id": "a289aa54-5488-4707-9a4b-eeea4edf311d", "created_at": "2025-06-15T16:54:17.946329Z", "custom_metadata": { "id": "internalId1" }, "errors": [], "user_identifier": { "api_url": "https://example.com/api", "email": "[e-mail]", "exclusive": true, "phone": "[phone]", "username": "jane_doe" }, "warnings": [] } ] */

200

{
  "connected_accounts": [
    {
      "accepted_capabilities": [
        "lock"
      ],
      "account_type_display_name": "<string>",
      "automatically_manage_new_devices": true,
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "custom_metadata": {},
      "display_name": "<string>",
      "errors": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "error_code": "account_disconnected",
          "message": "<string>",
          "is_bridge_error": true,
          "is_connected_account_error": true
        }
      ],
      "warnings": [
        {
          "error_code": "<string>",
          "message": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "account_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_key": "<string>",
      "default_checkin_time": "<string>",
      "default_checkout_time": "<string>",
      "ical_feed_origin": "<string>",
      "ical_url": "<string>",
      "image_url": "<string>",
      "time_zone": "<string>",
      "user_identifier": {
        "api_url": "<string>",
        "email": "<string>",
        "exclusive": true,
        "phone": "<string>",
        "username": "<string>"
      }
    }
  ],
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

api_keypat_with_workspaceconsole_session_with_workspaceclient_session_with_customer

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 connected accounts. Returns connected accounts with custom_metadata that contains all of the provided key:value pairs.

Show child attributes

customer_key · string

Customer key by which you want to filter connected accounts.

limit · integer · default: 11000

Maximum number of records to return per page.

Required range: x > 0

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 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.

Minimum string length: 1

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

application/json

OK

connected_accounts · object[] · required

Show child attributes

ok · boolean · required

pagination · object · required

Information about the current page of results.

Show child attributes