Skip to main content
POST
/
connected_accounts
/
get
await seam.connectedAccounts.get({
  connected_account_id: "a289aa54-5488-4707-9a4b-eeea4edf311d",
});

/*
{
  "account_type": "salto_space",
  "account_type_display_name": "Salto Space",
  "display_name": "j**n@example.com",
  "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": "jane_doe@example.com",
    "exclusive": true,
    "phone": "+1555551004",
    "username": "jane_doe"
  },
  "warnings": []
}
*/
{
  "connected_account": {
    "accepted_capabilities": [],
    "account_type_display_name": "<string>",
    "automatically_manage_new_devices": true,
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_metadata": {},
    "display_name": "<string>",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "error_code": "account_disconnected",
        "message": "<string>",
        "is_bridge_error": true,
        "is_connected_account_error": true
      }
    ],
    "warnings": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "account_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "customer_key": "<string>",
    "default_checkin_time": "<string>",
    "default_checkout_time": "<string>",
    "ical_feed_origin": "<string>",
    "ical_url": "<string>",
    "image_url": "<string>",
    "time_zone": "<string>",
    "user_identifier": {
      "api_url": "<string>",
      "email": "<string>",
      "exclusive": true,
      "phone": "<string>",
      "username": "<string>"
    }
  },
  "ok": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
connected_account_id
string<uuid>
required

ID of the connected account that you want to get.

Response

OK

​
connected_account
object
required

Represents a connected account. A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.

​
ok
boolean
required