List Connected Accounts

• Request Parameters

• Response

• Examples

Returns a list of all connected accounts.

JavaScript

Returns a list of all connected accounts for a specified user identifier key.

Code:

await seam.connectedAccounts.list({
  user_identifier_key: "2f393937-1405-4b1a-933f-34c97bfb3c56",
  limit: 50,
});

Output:

[
  {
    "account_type": "salto_space",
    "account_type_display_name": "Salto Space",
    "display_name": "j**[email protected]",
    "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": "[email protected]",
      "exclusive": true,
      "phone": "[phone]",
      "username": "jane_doe"
    },
    "warnings": []
  }
]

cURL

Python

Ruby

PHP

Seam CLI

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

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

---

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.

---

user_identifier_key String

Your user ID for the user by which you want to filter connected accounts.

---

Response

Returns: Array of connected_accounts

JSON

{
  "account_type": "salto_space",
  "account_type_display_name": "Salto Space",
  "display_name": "j**[email protected]",
  "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": "[email protected]",
    "exclusive": true,
    "phone": "[phone]",
    "username": "jane_doe"
  },
  "warnings": [],
  "accepted_capabilities": ["lock"]
}

---

Examples

List connected accounts for a customer

Returns a list of all connected accounts for a specified customer ID.

JavaScript

Code:

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

Output:

[
  {
    "account_type": "salto_space",
    "account_type_display_name": "Salto Space",
    "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": "[email protected]",
      "exclusive": true,
      "phone": "[phone]",
      "username": "jane_doe"
    },
    "warnings": []
  }
]

cURL

Python

Ruby

PHP

Seam CLI

---

List connected accounts with specific custom metadata

Returns a list of all connected accounts with specified custom metadata.

JavaScript

Code:

await seam.connectedAccounts.list({
  custom_metadata_has: { id: "internalId1" },
  limit: 50,
});

Output:

[
  {
    "account_type": "salto_space",
    "account_type_display_name": "Salto Space",
    "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": "[email protected]",
      "exclusive": true,
      "phone": "[phone]",
      "username": "jane_doe"
    },
    "warnings": []
  }
]

cURL

Python

Ruby

PHP

Seam CLI