| Cloud Connectivity | |
| Get cloud connection settings | Return cloud connection settings like hosts, ports for all possible groups of cloud servers |
| Get cloud server instance | Return individual cloud server connection settings |
| Get cloud server URL | Return cloud server connection URL |
| Get cloud by device | Return cloud instance by device ID |
| Authentication | |
| Login by username | Login with username/password/passcode |
| Send passcode | Generate and send a passcode |
| Login by key | Allow user to login using user key. |
| Logout | Logout the user and remove the API key from the database |
| Create TOTP Factor | Generate a new TOTP Factor for 2'nd authentication step |
| Confirm TOTP Factor | Confirm TOTP Factor |
| Get TOTP Factors | Get TOTP Factors |
| Delete TOTP Factor | Delete TOTP Factor |
| Get private key | Generate a new RSA signature for the user and a private key |
| Put public key | Upload own RSA public key to the account |
| Get operation token | Generate a new operation token |
| User Accounts | |
| Create user account | Register user account |
| Get user account info | Get user info and linked location(s) |
| Update user | Update user record |
| Delete user account | Delete user account |
| Get pronouns | Get supported pronouns |
| Send verification message | Send verification email or SMS |
| Provide verification code | Verify email address or phone number |
| Put new password | Set a new password |
| Recover password | Recover password |
| Reset user badges | Reset user badge count(s) |
| Get Terms of Services | Get Terms of Services |
| Put Terms of Service | Put Terms of Service |
| Put user tag | Apply a user tag |
| Delete user tag | Delete a user tag |
| Put User Code | |
| Get User Codes | |
| Delete User Code | |
| Locations | |
| Create location | Create a new location |
| Update location | Update location |
| Delete location | Delete location |
| Put location to organization | Move location to an organization by domain name |
| Post location event | Post location event to change current location scene. |
| Get location events history | Return location change scenes history |
| Get location priorities history | Return location priority change history |
| Get countries | Get countries data |
| Get location users | Get a list of location users |
| Add location users | Add users to a location with specified access |
| Update location user | Update location user attributes |
| Delete location user | Remove user from location |
| Get location spaces | Get spaces in specified location |
| Create/Update location space | Create or update a space in specified location |
| Delete location space | Delete specified location space |
| Get narratives | Search narratives by params |
| Put narrative | Create/update a narrative |
| Delete narrative | Delete specified narrative |
| Put state | A way for bots to set named location states with flexible JSON object structure. |
| Get state | UI apps can read a current location state by name. |
| Delete state | Delete all location states |
| Put time state | A way for bots to set named location states with flexible JSON object structure. |
| Get time states | UI apps can read a current location state by name. |
| Get location totals | Location totals |
| Get presence IDs | Return UUID's provided by all gateways, where the user has read access. |
| Add Location Presense | Authorize access to the location, where the gateway with provided parameters is located. |
| Devices | |
| Register a device | Register a device with optional parameters. |
| Get devices | Return a list of location devices. |
| Delete multiple devices | Remove multiple devices |
| Get single device | |
| Get pre-registered device | |
| Get device services | Get device services |
| Update device attributes | Update the device attributes |
| Remove device at a specific location | Remove device at a specific location |
| Device SIM card | Activate or deactivate device SIM cards |
| Device Copy Simulator | Create a device copy simulator |
| Get device activation information | Retrieve device activation information by product ID and email it to the user |
| Get device properties | Return device properties |
| Set device properties | Set device properties (batch version. |
| Delete device property | Delete device property |
| Link device to space | Link device to location space |
| Unlink device from space | Unlink device from location space |
| Get firmware update jobs | Get firmware update jobs listing. |
| Set firmware update job status | Set firmware update job status. |
| Get device logs | Get device logs. |
| Get device log content | Returns a temporary URL to download log's content. |
| Upload Sensitivity Map | Upload sensitivity map to device. |
| Delete Sensitivity Map | Delete sensitivity map for device. |
| VoIP Registration | Register device on a SIP server. |
| Delete VoIP Registration | Unregister device on a SIP server. |
| VoIP Call | Make a VoIP Call. |
| Hang Up VoIP Call | Hang Up VoIP Calls. |
| Device measurements | |
| Get specific device parameters | Get current measurements of specific device |
| Get multiple device parameters | Get current measurements of multiple devices |
| Send device command | Send a command to a device to set or get device parameters |
| Device readings history | Device readings history |
| Last device readings | Last N device readings |
| Get device alerts | List of device alerts by criteria |
| Submit data request | Submit asynchronous data requests |
| Get data requests | Completed data requests can be retrieved by calling this API |
| Get units of measurement | Return supported units of measurement |
| User Communication | |
| Get notification subscriptions | Get notification subscriptions |
| Set notification subscriptions | Set notification subscriptions |
| Post Push Notification Token | Post Push Notification Token |
| Delete Push Notification Token | Delete device notification token |
| Send notification | Send an arbitrary push notification or email to the user |
| Get notifications | Retrieve user notifications log |
| Post support ticket | |
| Post feedback | |
| Get Feedback by Search | |
| Get Specific Feedback | |
| Vote for feedback | |
| Support | Request support |
| Get questions | Returns questions, and also the answers if the user key is specified. |
| Answer questions | Answers to the questions |
| Get survey questions | Returns survey questions. |
| Put survey answer | Put survey answer. |
| Get message topics | Get a list of message topics. |
| Create message | Bots and users use the API to create a message. |
| Get messages | Get a list of messages filtered by parameters. |
| Update messages | Bots use the API to update their messages. |
| Update message read status | A user can mark a message as read or unread. |
| System and User Properties | |
| Get Property | Get single user or system property |
| Get user properties | Get user properties (batch version) |
| Set user property | Set user property |
| Set user properties | Set user properties (batch version) |
| Device Files | |
| Upload file | Upload a binary file |
| Upload a binary files parts or thumbnail | Upload a binary files parts or thumbnail |
| Get files | List of device files |
| Delete all files | Delete all user device files |
| Get Last N Files | Return a list of last N the user's files before specific date |
| Get file download URL's | Download file content or thumbnail from URL's |
| Download file | Download file content or thumbnail |
| Update file | Update device file attributes |
| Delete single file | Delete a single device file |
| Get files summary | Return a summary of user files by file types and creation dates. |
| Get file info | Return information about specific device file |
| Get file devices | Return all combinations of device ID's and device descriptions from existing user files. |
| Report file | Report file |
| App files | |
| Upload file content | |
| Get files | |
| Download file | |
| Delete file | |
| Rules | |
| Get conditions and actions | Retrieve rule phrases |
| Create/Update Rule | Create a new rule or update existing rule. |
| Get rules | Retrieve a list of user rules filtered by rule ID and device ID. |
| Delete rules | Delete rules by criteria |
| Update rule attrs | Modify existing rule's attributes (name, status). |
| Delete rule | Delete a rule by ID |
| Update rules status | Update status of existing rules. |
| Create default rules | Create default rules, if they do not exist, for individual or all user devices. |
| Paid Services | |
| Get service plans | Return a list of paid service plans available for sale and sold to the user |
| Post an Apple purchase receipt | Provide an Apple Purchase Receipt |
| Get payment profiles | Return a list of payment profiles for user |
| Post purchase info | Provide new purchase info |
| Update purchase info | Update purchase info for existing paid service plan |
| Upgrade purchased plan | Upgrade existing user service plan to another with different services |
| Get location service plans | Return a list of subscriptions |
| Get transactions | Return payment transactions for a specific user service plan |
| Assign services to location | Assign a service plan to another user. |
| Assign services to group of users | Assign the plan to a group of users identified by login names |
| Cancel user service plan | |
| Get market products | Return a list of products in the market |
| Get Chargify token | Return Chargify token representing user's payment attributes |
| Professional Monitoring | |
| Get call center settings | Get call center settings in Avantguard |
| Provide call center settings | Add/Update call center settings in Avantguard |
| Cancel call center | Cancel call center settings in Avantguard |
| Create call center test | Create call center account test |
| Cancel call center test | Cancel call center test mode |
| Get call center alerts | Get call center alerts history |
| Energy Management | |
| Get location energy usage | Return aggregated energy usage and cost for a specified date range aggregated by different time periods |
| Get current device energy usage | Return aggregated energy usage and cost for a specified date range aggregated by different time periods |
| Get aggregated device energy usage | Return aggregated energy usage and cost for a specified date range aggregated by different time periods |
| Get billing setting | Return location billing information: billing rate |
| Weather | |
| Get Weather | Get Weather |
| Device Types and Parameters | |
| Get device types | Get supported device types |
| Get device type attributes | Get device type attributes |
| Create/update device type | Create new or update existing device type |
| Get device parameters | Return supported device parameters |
| Post device parameter | Create new or edit existing device parameter. |
| Delete device parameter | Delete existing device parameter |
| Put device parameter | Change existing device parameter with the "description" and "displayInfo" properties (and only them) |
| Get default rules | Get device type default rules |
| Add default rule | Add default rule |
| Delete default rule | Delete default rule |
| Get device goals by types | Retrieve device goals by device type |
| Get device goal installation instruction | Device installation instructions by goal ID. |
| Put media | Create or update some media data |
| Get media | List stored media |
| Delete media | Delete one or several media |
| Put device models | Upload device models and categories |
| Get device models | Get device categories, models, and related media |
| Delete device model data | Delete category, model, or brand |
| Get stories | Get stories, pages, and related models and media |
| Put stories | Upload stories, with pages and references to the models and media |
| Delete story | Delete a story |
| Clouds Integration | |
| Get 3'rd party clouds | Return a list of supported 3'rd party clouds, where a user may obtain authorization |
| Access 3'rd party cloud | Redirect a user to the 3'rd party cloud web page for authenticating and authorizing access to user's data |
| Revoke access to 3'rd party cloud | The user may revoke authorization to access the user's data on a 3'rd party cloud |
| Authorize 3'rd party client | Begin the process of authorizing a 3'rd party client to access the user's data. The client has to redirect the user to this HTTP GET URL. |
| Approve or deny client authorization | Allow a user to approve or deny an authorization request from the 3'rd party client |
| Get access token | Return OAuth 2.0 access token by authorization code or refresh token |
| Update OAuth client | The user can update access to devices for Smart Home client |
| Revoke OAuth client | The user can revoke authorization for a 3'rd party client |
| RAG | |
| Upload Document | Upload a single document |
| Get Documents | Get documents |
| Update Document | Update Document Properties |
| Delete Document | Delete document |
| Post Questions | Post Questions |
| Get Questions | Get Questions |
| Update Questions | Update Questions |
| Community | |
| Get community posts | Get community posts |
| Create a community post | Create a community post |
| Update a community post | Update a community post |
| Delete a community post | Delete a community post |
| Comment community post | Comment community post |
| Delete a comment | Delete a comment |
| Community post reaction | Community post reaction |
| Create a file | Create community post file |
| Complete a file | Complete community post file |
| Delete a file | Delete community post file |
| Get file URLS | Get community post file URLs |
| WebSocket |
| HL7 | |
| HL7 Bulk Load | Patient bulk load |