GET Group

URL: /group

Accessible by: Smart accounts (Si, Carrier, Bryant, ecobee3 thermostats) only. Excludes Smart thermostats.

Retrieves the Group and grouping data for the Thermostats registered to the particular User. The User here refers to the calling application's user authorization.

Note: The Selection.SelectionType can only be registered for this request.

Request Properties

Property	Version	Type	Read Only	Required	Description
selection	1	Selection	No	Yes	The selection criteria for the request.

Response Properties

Property	Version	Type	Read Only	Required	Description
groups	1	Group []	Yes	n/a	The list of Groups returned by the request.
status	1	Status	Yes	n/a	The api response code.

Example Request:

Request Body

NOTE: Request body is not encoded for example purposes.

HEADERS:
    Content-Type: application/json;charset=UTF-8
    Authorization: Bearer Rc7JE8P7XUgSCPogLOx2VLMfITqQQrjg
    
REQUEST:
    GET https://api.ecobee.com/1/group?format=json&body={"selection":{"selectionType":"registered"}}
    			

Sample API Call

curl -s -H 'Content-Type: text/json' -H 'Authorization: Bearer ACCESS_TOKEN' 'https://api.ecobee.com/1/group?format=json&body=\{"selection":\{"selectionType":"registered"\}\}'
				

					
$.ajax({
    beforeSend: function(request) {
        request.setRequestHeader("Authorization", "Bearer ".concat(ACCESS_TOKEN));
    },
    dataType: "json",
    url: 'https://api.ecobee.com/1/group?format=json&body=\{"selection":\{"selectionType":"registered"\}\}',
    success: function(data) {
    	var response = JSON.stringify(data, null, 4);
    }
});
				

Example Response:

{
  "groups": [
    {
      "groupRef": "3bb5a91b180001",
      "groupName": "ground_floor",
      "synchronizeAlerts": false,
      "synchronizeSystemMode": true,
      "synchronizeSchedule": false,
      "synchronizeQuickSave": false,
      "synchronizeReminders": false,
      "synchronizeContractorInfo": false,
      "synchronizeUserPreferences": false,
      "synchronizeUtilityInfo": false,
      "synchronizeLocation": false,
      "synchronizeReset": true,
      "synchronizeVacation": false,
      "thermostats": [
        "123456789101"
      ]
    },
    {
      "groupRef": "3bb5a91b180000",
      "groupName": "first_floor",
      "synchronizeAlerts": false,
      "synchronizeSystemMode": true,
      "synchronizeSchedule": false,
      "synchronizeQuickSave": false,
      "synchronizeReminders": false,
      "synchronizeContractorInfo": false,
      "synchronizeUserPreferences": false,
      "synchronizeUtilityInfo": false,
      "synchronizeLocation": false,
      "synchronizeReset": true,
      "synchronizeVacation": false,
      "thermostats": [
        "123456789102"
      ]
    }
  ],
  "status": {
    "code": 0,
    "message": ""
  }
}
    

Back To Top