Get a Connected Account
Returns a specified connected account.
Returns a specified connected account, using an ID.
Code:
await seam.connectedAccounts.get({
connected_account_id: "a289aa54-5488-4707-9a4b-eeea4edf311d",
});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": "+1555551004",
"username": "jane_doe"
},
"warnings": []
}Returns a specified connected account, using an ID.
Code:
curl --include --request POST "https://connect.getseam.com/connected_accounts/get" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"connected_account_id": "a289aa54-5488-4707-9a4b-eeea4edf311d"
}
EOFOutput:
{
"connected_account": {
"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": "+1555551004",
"username": "jane_doe"
},
"warnings": []
}
}Returns a specified connected account, using an ID.
Code:
seam.connected_accounts.get(connected_account_id="a289aa54-5488-4707-9a4b-eeea4edf311d")Output:
ConnectedAccount(
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": "+1555551004",
"username": "jane_doe",
},
warnings=[],
)Returns a specified connected account, using an ID.
Code:
seam.connected_accounts.get(connected_account_id: "a289aa54-5488-4707-9a4b-eeea4edf311d")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: "+1555551004",
username: "jane_doe",
},
"warnings" => [],
}Returns a specified connected account, using an ID.
Code:
$seam->connected_accounts->get(
connected_account_id: "a289aa54-5488-4707-9a4b-eeea4edf311d"
);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" => "+1555551004",
"username" => "jane_doe",
],
"warnings" => [],
];Returns a specified connected account, using an ID.
Code:
seam connected-accounts get --connected_account_id "a289aa54-5488-4707-9a4b-eeea4edf311d"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": "+1555551004",
"username": "jane_doe"
},
"warnings": []
}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
{
"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": "+1555551004",
"username": "jane_doe"
},
"warnings": [],
"accepted_capabilities": ["lock"]
}Examples
Get a connected account for an email address
Returns a specified connected account, using an email address.
Code:
await seam.connectedAccounts.get({ email: "[email protected]" });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": "+1555551004",
"username": "jane_doe"
},
"warnings": []
}Code:
curl --include --request POST "https://connect.getseam.com/connected_accounts/get" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"email": "[email protected]"
}
EOFOutput:
{
"connected_account": {
"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": "+1555551004",
"username": "jane_doe"
},
"warnings": []
}
}Code:
seam.connected_accounts.get(email="[email protected]")Output:
ConnectedAccount(
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": "+1555551004",
"username": "jane_doe",
},
warnings=[],
)Code:
seam.connected_accounts.get(email: "[email protected]")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: "+1555551004",
username: "jane_doe",
},
"warnings" => [],
}Code:
$seam->connected_accounts->get(email: "[email protected]");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" => "+1555551004",
"username" => "jane_doe",
],
"warnings" => [],
];Code:
seam connected-accounts get --email "[email protected]"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": "+1555551004",
"username": "jane_doe"
},
"warnings": []
}Last updated
Was this helpful?

