List Connected Accounts

• Request Parameters

• Response

Returns a list of all connected accounts.

JavaScript

List all connected accounts.

Code

await seam.connectedAccounts.list();

Output

[
  {
    "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
    "created_at": "2022-08-24T10:38:05.128Z",
    "account_type": "schlage"
  },
  {
    "connected_account_id": "dc0df710-376c-4ec3-9b2b-2b7f788bdfa8",
    "created_at": "2022-07-04T08:40:02.110Z",
    "account_type": "kwikset"
  }
]

cURL

List all connected accounts.

Code

curl --include --request POST "https://connect.getseam.com/connected_accounts/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

{
  "connected_accounts": [
    {
      "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
      "created_at": "2022-08-24T10:38:05.128Z",
      "account_type": "schlage"
    },
    {
      "connected_account_id": "dc0df710-376c-4ec3-9b2b-2b7f788bdfa8",
      "created_at": "2022-07-04T08:40:02.110Z",
      "account_type": "kwikset"
    }
  ]
}

Python

List all connected accounts.

Code

seam.connected_accounts.list()

Output

[
    ConnectedAccount(
        connected_account_id="23e4eb21-6e93-48c4-a077-bf503246d47c",
        created_at="2022-08-24T10:38:05.128Z",
        account_type="schlage",
    ),
    ConnectedAccount(
        connected_account_id="dc0df710-376c-4ec3-9b2b-2b7f788bdfa8",
        created_at="2022-07-04T08:40:02.110Z",
        account_type="kwikset",
    ),
]

Ruby

List all connected accounts.

Code

seam.connected_accounts.list()

Output

[
  {
    "connected_account_id" => "23e4eb21-6e93-48c4-a077-bf503246d47c",
    "created_at" => "2022-08-24T10:38:05.128Z",
    "account_type" => "schlage",
  },
  {
    "connected_account_id" => "dc0df710-376c-4ec3-9b2b-2b7f788bdfa8",
    "created_at" => "2022-07-04T08:40:02.110Z",
    "account_type" => "kwikset",
  },
]

PHP

List all connected accounts.

Code

<?php
$seam->connected_accounts->list();

Output

<?php
[
    [
        "connected_account_id" => "23e4eb21-6e93-48c4-a077-bf503246d47c",
        "created_at" => "2022-08-24T10:38:05.128Z",
        "account_type" => "schlage",
    ],
    [
        "connected_account_id" => "dc0df710-376c-4ec3-9b2b-2b7f788bdfa8",
        "created_at" => "2022-07-04T08:40:02.110Z",
        "account_type" => "kwikset",
    ],
];

Seam CLI

List all connected accounts.

Code

seam connected-accounts list

Output

[
  {
    "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
    "created_at": "2022-08-24T10:38:05.128Z",
    "account_type": "schlage"
  },
  {
    "connected_account_id": "dc0df710-376c-4ec3-9b2b-2b7f788bdfa8",
    "created_at": "2022-07-04T08:40:02.110Z",
    "account_type": "kwikset"
  }
]

Authentication Methods

• API key

• 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_ids Array of UUIDs

---

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.

---

user_identifier_key String

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

---

Response

Array of connected_accounts