Get a Connected Account

• Request Parameters

• Response

• Examples

Returns a specified connected account.

Signature

POST /connected_accounts/get ⇒ { connected_account }

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

connected_account_id String

ID of the connected account that you want to get.

---

email String

Email address associated with the connected account that you want to get.

---

Response

connected_account

---

Examples

Get a connected account

Specify the connected_account_id of the connected account that you want to get.

JavaScript

Code

await seam.connectedAccounts.get({
  connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c",
});

Output

[
  {
    "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
    "created_at": "2022-08-24T10:38:05.128Z",
    "account_type": "schlage"
  }
]

Python

Code

seam.connected_accounts.get(connected_account_id="23e4eb21-6e93-48c4-a077-bf503246d47c")

Output

[
    ConnectedAccount(
        connected_account_id="23e4eb21-6e93-48c4-a077-bf503246d47c",
        created_at="2022-08-24T10:38:05.128Z",
        account_type="schlage",
    )
]

Ruby

Code

seam.connected_accounts.get(connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c")

Output

[
  {
    "connected_account_id" => "23e4eb21-6e93-48c4-a077-bf503246d47c",
    "created_at" => "2022-08-24T10:38:05.128Z",
    "account_type" => "schlage",
  },
]

PHP

Code

<?php
$seam->connected_accounts->get(
    connected_account_id: "23e4eb21-6e93-48c4-a077-bf503246d47c"
);

Output

<?php
[
    [
        "connected_account_id" => "23e4eb21-6e93-48c4-a077-bf503246d47c",
        "created_at" => "2022-08-24T10:38:05.128Z",
        "account_type" => "schlage",
    ],
];

Seam CLI

Code

seam connected-accounts get --connected_account_id "23e4eb21-6e93-48c4-a077-bf503246d47c"

Output

[
  {
    "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
    "created_at": "2022-08-24T10:38:05.128Z",
    "account_type": "schlage"
  }
]

Go

Code

package main

import api "github.com/seamapi/go"

func main() {
	client.ConnectedAccounts.Get(
		context.Background(),
		api.ConnectedAccountsGetRequest{
			ConnectedAccountId: api.String("23e4eb21-6e93-48c4-a077-bf503246d47c"),
		},
	)
}

Output

[]api.ConnectedAccount{api.ConnectedAccount{ConnectedAccountId: "23e4eb21-6e93-48c4-a077-bf503246d47c", CreatedAt: "2022-08-24T10:38:05.128Z", AccountType: "schlage"}}

cURL

Code

curl --include --request POST "https://connect.getseam.com/connected_accounts/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c"
}
EOF

Output

{
  "connected_account": [
    {
      "connected_account_id": "23e4eb21-6e93-48c4-a077-bf503246d47c",
      "created_at": "2022-08-24T10:38:05.128Z",
      "account_type": "schlage"
    }
  ]
}