Get a Connected Account

Get a Connected Account by its ID

/connected_accounts/get

POSThttps://connect.getseam.com/connected_accounts/get
Authorization
Body
one of
Response

OK

Body
connected_account*connected_account (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/connected_accounts/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();
Response
{
  "connected_account": {
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-12-10T07:49:05.571Z",
    "user_identifier": {
      "username": "text",
      "api_url": "text",
      "email": "text",
      "phone": "text",
      "exclusive": false
    },
    "account_type": "text",
    "account_type_display_name": "text",
    "errors": [
      {
        "message": "text",
        "is_connected_account_error": true,
        "error_code": "text"
      }
    ],
    "warnings": [
      {
        "message": "text",
        "warning_code": "text"
      }
    ],
    "automatically_manage_new_devices": false
  },
  "ok": false
}

Code Examples

Retrieving using "connected_account_id"

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

console.log(connectedAccount)

Retrieving using "email"

connect_account = seam.connected_accounts.get(
    email: "jane@example.com"
)

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": "jane@example.com"}                                                                    
#   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

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

Last updated

Logo

© Seam Labs, Inc. All rights reserved.