Get a Connected Account

Get a Connected Account by its ID

Get Connected Account

GET https://connect.getseam.com/connected_accounts/get

Query Parameters

Name	Type	Description
connected_account_id*	String	ID of the Connected Account

Headers

Name	Type	Description
Authorization*	String	Bearer <API_KEY>

200: OK

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

404: Not Found

{
  "error": {
    "type": "connected_account_not_found",
    "message": "Connected account not found",
    "request_id": "100da4e3-2a68-4a77-a4ac-50b6cc0ac987"
  },
  "ok": false
}

Code Examples

Retrieving using "connected_account_id"

Ruby

seam.connected_accounts.get(
    connected_account_id: "123e4567-e89b-12d3-a456-426614174000"
)

# <Seam::ConnectedAccount:0x00ed1e8                                                            
#   connected_account_id="282f9d15-d979-4de7-b4eb-7097c401e910"                                
#   created_at="2022-07-06T09:43:07.125Z"                                                      
#   user_identifier=nil                                                                        
#   account_type="smartthings"> 

Python

seam.connected_accounts.get("c6610ba7-88d7-4abf-9852-31eb0257aa56")

# ConnectedAccount(
#   connected_account_id='c6610ba7-88d7-4abf-9852-31eb0257aa56', 
#   created_at='2022-08-23T12:43:49.542Z', 
#   user_identifier={'email': '[email protected]'}, 
#   account_type='schlage', 
#   errors=[]
# )

Javascript

await seam.connectedAccounts.get(
    "c6610ba7-88d7-4abf-9852-31eb0257aa56"
);
  
// {
//   connected_account_id: 'c6610ba7-88d7-4abf-9852-31eb0257aa56',
//   created_at: '2022-08-23T12:43:49.542Z',
//   user_identifier: { email: '[email protected]' },
//   account_type: 'schlage',
//   errors: []
// }

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
}