Retrieve collections

This API is used to retrieve the list of collections belonging to the user.

{
    "collections":[
        {
            "collection_uuid":"8ae79d4b-bc40-4bc3-889e-7cbddda0c0ad"
            "name":"Good Morning"
            "type":"SCENE"
            "is_active":true
            "devices":[
                {
                    "dsn":"TESTDSN_787294_001"
                    "product_name":"TESTDEVICE_001"
                    "oem_model":"ledevb"
                    "lan_enabled":false
                    "connected_at":"2020-07-06T11:08:03Z"
                    "connection_status":"Offline"
                    "states":[
                        {
                            "property_name":"integer_output_tp1"
                            "base_type":"integer"
                            "property_value":1008
                        }
                        {
                            "property_name":"string_input_tp1"
                            "base_type":"string"
                            "property_value":"OK"
                        }
                    ]
                }
                {
                    "dsn":"TESTDSN_763168_004"
                    "product_name":"TESTDEVICE_004"
                    "oem_model":"ledevb-test"
                    "lan_enabled":false
                    "connected_at":"2020-02-08T05:33:08Z"
                    "connection_status":"Offline"
                    "states":[
                        {
                            "property_name":"integer_output_tp1"
                            "base_type":"integer"
                            "property_value":1008
                        }
                        {
                            "property_name":"string_input_tp1"
                            "base_type":"string"
                            "property_value":"OK"
                        }
                    ]
                }
                {
                    "dsn":"TESTDSN_177487_002"
                    "product_name":"TESTDEVICE_002"
                    "oem_model":"ledevb-test"
                    "lan_enabled":false
                    "connected_at":"2020-02-20T10:33:01Z"
                    "connection_status":"Online"
                    "states":[
                        {
                            "property_name":"integer_input_tp"
                            "base_type":"integer"
                            "property_value":1008
                        }
                        {
                            "property_name":"decimal_input_tp"
                            "base_type":"decimal"
                            "property_value":1008.1008
                        }
                    ]
                }
            ]
            "child_collections":[
                {
                    "collection_uuid":"a8ae010c-2dde-4140-8e19-116363eaa475"
                    "name":"Room102"
                    "states":[
                        {
                            "property_name":"integer_output_tp1"
                            "base_type":"integer"
                            "property_value":1008
                        }
                        {
                            "property_name":"string_input_tp1"
                            "base_type":"string"
                            "property_value":"OK"
                        }
                    ]
                }
                {...}
            ]
            "custom_attributes":{
                "color":"#F08080"
                "sort_order":"ascending"
            }
            "schedule":{
                "end_date":"2021-12-02"
                "days_of_week":"[1, 2, 3, 4, 5, 6, 7]"
                "months_of_year":"[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]"
                "end_time_each_day":"00:00:00"
                "start_time_each_day":"00:00:00"
                "name":"sched-2021-09-15-21:40:08"
                "days_of_month":"[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, ..."
                "active":true
                "start_date":"2021-10-02"
                "metadata": {
                   "sunrise_sunset": true
                 },
                "time_zone" : "America/Los_Angeles",
                "utc" : false
                }
            }
        ]
        "total":1
        "previous_page":NULL
        "next_page":NULL
        "current_page_number":1
        "start_count_on_page":1
        "end_count_on_page":1
    }
Language
Credentials
Header
Click Try It! to start a request and see the response here!