List Connected Accounts

{ "connected_accounts": [ { "accepted_capabilities": [ "lock" ], "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>" } } ], "pagination": { "has_next_page": true, "next_page_cursor": "<string>", "next_page_url": "<string>" } }

Authorizations

Authorization

string

header

required

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

Query Parameters

user_identifier_key

string

Your user ID for the user by which you want to filter connected accounts.

Minimum string length: 1

custom_metadata_has

object

Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with custom_metadata that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify null to match a key that is unset. A key given an empty string is omitted from the filter.

Show child attributes

customer_key

string

Customer key by which you want to filter connected accounts.

Minimum string length: 1

space_id

string<uuid>

ID of the space by which you want to filter connected accounts.

string

String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using connected_account_id, account_type, customer_key, custom_metadata, user_identifier.username, user_identifier.email or user_identifier.phone.

Minimum string length: 1

limit

integer

default:11000

Maximum number of records to return per page.

Required range: x > 0

page_cursor

string | null

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

Response

connected_accounts

object[]

required

Show child attributes

pagination

object

required

Information about the current page of results.

Show child attributes

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

List Connected Accounts

Authorizations

Query Parameters

Response