| System | |
| System Status | System running statistics |
| Organizations | |
| Get Brands | Get Brands |
| Create Organization | Create a new organization |
| Edit Organization | update an existing organization |
| Get Organizations | Retrieve organizations information |
| Delete Organization | Delete organization. |
| Upload Large Object | Upload a large object for the organization. Only organization administrators can use the API. |
| Download Large Object | Download an organization's large object by object name. Only organization administrators can download private objects. |
| Delete Object | Remove a large object/property from organization. Only organization administrators can use the API. |
| Get Objects and Properties | Return a list of the organization's large objects and properties. Only organization administrators can get private items. |
| Set Organization Properties | Post a set of properties to be saved as the organization's objects. Only organization administrators can use the API. |
| Organization Totals | Get total numbers of users, locations, devices in the organization. |
| Get Bot Instances | Return a list of the organization's bot instances. Only organization administrators can use the API. |
| Test notification templates | Test notification templates. |
| Groups | |
| Create Organization Group | Create a new organization group |
| Edit Organization Group | update an existing organization group |
| Get Organization Groups | Retrive organization groups |
| Remove Organization Group | Remove organization group |
| Users | |
| Get Users | Retrieve users |
| Get Roles | Retrieve all existing roles, which can be granted to a user |
| Grant User Role | Grant a role to a user |
| Revoke User Role | Revoke a role from a user |
| Get Organization Admins | Get list of Organization Admins |
| Add Organization Admin | Set given user as an organization admin |
| Remove Organization Admin | Remove given user from organization admins |
| Get Notification Users | Get organization notification users |
| Update Notification User | Update organization notification user categories |
| User Groups | |
| Create User Group | Create a new organization user group |
| Update User Group | Update an existing organization user group |
| Get User Groups | Retrieve organization user groups |
| Delete User Group | Delete an organization user group |
| Add User Group Member | Add a user to organization user group |
| Remove User Group Member | Remove user from organization user group |
| Locations | |
| Get Organization Locations | Lists the organization's locations. Only organization administrators can use the API. |
| Create Organization Location | Create new location for the organization. Only organization administrators can use the API. |
| Update Organization Location | Update organization's location. Only organization administrators can use the API. |
| Delete Organization Location | Delete organization's location. Only organization administrators can use the API. |
| Add/Update/Delete Organization Locations | Add or Update or Remove locations to/from organization. |
| Devices | |
| Get Organization Devices | Lists the organization's devices. Only organization administrators can use the API. |
| Get firmware versions | |
| Upload firmware version | |
| Delete firmware version | |
| Update device firmware group | |
| Create firmware update job | |
| Get firmware update jobs | |
| Delete firmware update job | |
| Challenges | |
| Create Challenge | Create a new challenge. Challenges can be created and changed only by an administrator |
| Update Challenge | Update challenge. Challenges can be changed only by an administrator |
| Update Challenge Status | Update challenge status. Can be called only by an administrator |
| Get Challenges | Retrieve challenges by organization |
| Delete Challenge | Delete an existing challenge. Can be called by an administrator |
| Get Challenge Participants | Retrieve challenge participants. Only organization users can call it. |
| Update Challenge Participant | Update Event Participant Status. |
| Get Energy Usage | Retrieve demand response challenge participants energy usage and baseline for the challenge period. |
| Tags | |
| Apply Tags | Apply the tags to the organization users, locations, devices. The tags can be applied only by the administrators |
| Delete Tag | Remove a tag from the organization user, location, device. The tag can be removed only by the administrators |
| Get Popular Tags | List the most popular tags applied to the organization users, locations, devices. Can be called only by the administrators |
| Narratives | |
| Get Organization Narratives | Return a list of the narratives with negative priority. Can be called only by the administrators |
| Billing | |
| Get Billing Items | List all billing items |
| Create Billing Plan | Create a new billing plan |
| Get Billing Plans | List all billing plans |
| Create Billing Plan Version | Create a new verion of billing plan |
| Get Billing Plan Versions | List billing plan versions, optionally filtered by a date range< |
| Get Organization Billing Plans | List of billing plans for organization |
| Set Organization Billing Plan | Specify a billing plan for organization |
| Delete Organization Billing Plan | Disable billing plans for organization |
| Generate Bill | Generate bill for organization |
| Get Bills | Get bills generated for organization |
| Get Bill Content | Download bill content as specified format for organization |