Get a Connected Account

Get a Connected Account by its ID

/connected_accounts/get

post

Returns a specified connected account.

Authorizations

client_sessionclient_session_with_customerapi_keypat_with_workspaceconsole_session_with_workspace

Body

one ofOptional

or

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /connected_accounts/get HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer Client Session Token
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "connected_account_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "connected_account": {
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-07-04T08:29:56.137Z",
    "user_identifier": {
      "username": "text",
      "api_url": "text",
      "email": "text",
      "phone": "text",
      "exclusive": true
    },
    "account_type": "text",
    "account_type_display_name": "text",
    "errors": [
      {
        "created_at": "2025-07-04T08:29:56.137Z",
        "message": "text",
        "is_connected_account_error": true,
        "is_bridge_error": true,
        "error_code": "account_disconnected"
      }
    ],
    "warnings": [
      {
        "created_at": "2025-07-04T08:29:56.137Z",
        "message": "text",
        "warning_code": "scheduled_maintenance_window"
      }
    ],
    "custom_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "automatically_manage_new_devices": true,
    "customer_key": "text",
    "accepted_capabilities": [
      "lock"
    ]
  },
  "ok": true
}

Code Examples

Retrieving using "connected_account_id"

Javascript

const connectedAccount = await seam.connectedAccounts.get({
  connected_account_id: "123e4567-e89b-12d3-a456-426614174000"
})

console.log(connectedAccount)

Python

# Get a connected account by its ID
connected_account = seam.connected_accounts.get("123e4567-e89b-12d3-a456-426614174000")

# Print the details of the connected account
print(connected_account)

Ruby

# Use the Seam SDK to get a connected account by its id
connected_account = seam.connected_accounts.get(
    connected_account_id: "123e4567-e89b-12d3-a456-426614174000"
)

# Print the details of the connected account
puts connected_account

PHP

// Get a connected account by its ID
$connected_account = $seam->connected_accounts->get(
  "123e4567-e89b-12d3-a456-426614174000"
);

echo json_encode($connected_account);

Retrieving using "email"

Ruby

connect_account = seam.connected_accounts.get(
    email: "[email protected]"
)

puts connect_account
# <Seam::ConnectedAccount:0x00ed1e8                                                            
#   connected_account_id="282f9d15-d979-4de7-b4eb-7097c401e910"                                
#   created_at="2022-07-06T09:43:07.125Z"                                                      
#   user_identifier={"email": "[email protected]"}                                                                    
#   account_type="smartthings"> 

Parameters

connected_account_id	type: string Optional	ID of the Connected Account
email	type: string Optional	Email associated with the account

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "connected_account": {
    "connected_account_id": "9dcedcb3-5ede-4b66-9e07-f9ef97b3c29b",
    "created_at": "2022-08-24T10:38:05.128Z",
    "user_identifier": {
      "email": "[email protected]"
    },
    "account_type": "schlage",
    "errors": []
  },
  "ok": true
}