This is the documentation for the Flair API. In this document, we will go over authorization and authentication, dive into a typical user setup and how to navigate and interact with it, and also provide a reference for all supported endpoints and their corresponding attributes.
\nYou may find your Flair API OAuth 2.0 credentials inside of your Flair App under the Account Settings menu, at the bottom, under Developer Settings. If you have any questions or comments, please reach out to support@flair.co.
\nFlair has also published a rudimentary python interface for faster development:
https://github.com/flair-systems/flair-api-client-py
\n\nA python client supporting OAuth 2.0 is currently in preview and can be installed using:
\npip install git+https://github.com/flair-systems/flair-api-client-py.git@refs/pull/9/head
The new Python client includes a special fallback mechanism that supports both OAuth 2.0 and OAuth 1.0 (legacy) credentials without additional configuration, prioritizing OAuth 2.0. This fallback behavior can be adjusted.
Please remember to keep your credentials safe.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5353571","collectionId":"63cd472d-6aa5-428e-9c3f-b7e975f896a4","publishedId":"TzsbKTAG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-26T21:09:19.000Z"},"item":[{"name":"Getting Started","item":[],"id":"cb0e8d10-6085-455b-9dd1-366d5d1cce15","description":"Here is a small guide on how to get started interfacing with the Flair API:
\nCreate a Flair account with a developer email address at
\n\n.
\nPersonal credentials can be access through the Flair App's Account Settings (at the bottom) - these are OAuth 2.0 credentials.
\nOAuth 1.0 credentials are being depcreated in favor of OAuth 2.0 and our SDKs will be updated soon to reflect this. Check out
\n\nfor details on how to get started.
\nWith your access token, you can check out some examples:
\n\nJSON API is a specification for HATEOAS APIs using JSON as their base media type. It uses the application/vnd.api+json as its media type and clients SHOULD set both their Accept and Content-Type headers to that media type, though the Flair API will be more lax than the specification on this count.
\nJSON API describes a standard method for CRUD actions against API resources and how to describe and modify relationships between resources using hypermedia. The full spec is available here, but people interacting with the the API will probably want to use a pre-existing client implementation.
\nError Objects look like:
\n{\n \"errors\": {\n \"title\": \"Not Found\",\n \"code\": \"404\",\n \"detail\": \"users resource with id 2 was not found\"\n }\n}
\nA request to create a resource:
\nPOST /api/structures
\n{\n \"data\": {\n \"type\": \"structures\",\n \"attributes\": {\n \"name\": \"Winter Home\"\n },\n \"relationships\": {\n \"admin-users\": [{\n \"id\": \"1\",\n \"type\": \"users\"\n }]\n }\n }\n}
\nA request to update a resource:
\nPUT /api/users/2
\n{\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\",\n \"attributes\": {\n \"name\": \"Will Paget\"\n }\n }\n}
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"98bde631-8144-445f-9354-dcaea6c3e83c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"82eab1b3-1e01-4e43-be67-0ae02fe5d4c6"}}],"_postman_id":"d2ae125c-3bdb-478e-9741-d08b8464d120","auth":{"type":"oauth2","oauth2":{"accessToken":"Third parties can request authorization here by redirecting the user to a url like /oauth2/authorize?client_id={application id}&redirect_uri={uri to return the user to}&scope={' ' (space) separated list of scopes}&response_type=code&state={state to verify the request wasnt tampered with}.
\nHere is an example for the scope parameter:
\nscope=thermostats.view structures.edit structures.view
\n","auth":{"type":"oauth2","oauth2":{"accessToken":"The Flair API uses OAuth2 for Authorization. We support all OAuth workflows. Only Authorized Users, 'Partners', may register OAuth clients with the API. Contact partners@flair.co for more information.
\nAll scopes are divided into '.view' and '.edit' varities. Clients with view permissions may only make GET requests for the resources, while those with both the view and edit scopes may make any kind of request for scopes. A Resources's required scopes are noted in the resource documentation below.
\nClients using the implicit grant may only request '.view' scopes.
\nHere is an example for the scope parameter:\nscope=thermostats.view structures.edit structures.view
\nThe most common scopes include:
\n/oauth2/authorize
\nThird parties can request authorization here by redirecting the user to a url like /oauth2/authorize?client_id={application id}&redirect_uri={uri to return the user to}&scope={' ' (space) separated list of scopes}&response_type=code&state={state to verify the request wasn't tampered with}. Third parties must register their redirect URIs with Flair. Please email your Flair contact or partners@flair.co to register your URI.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1bb266b8-751b-4947-a4c7-3d2f17934111"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cf009251-f631-4cc8-9896-f0732d2fbb8f"}}],"_postman_id":"877503a1-9e0b-41de-91e8-f857175e0a00","auth":{"type":"oauth2","oauth2":{"accessToken":"This endpoint is used to obtain an access token for authenticating API requests. It follows the OAuth2 protocol, allowing clients to securely access resources.
\nMethod: POST
URL: https://api.flair.co/oauth2/token
Content-Type: application/x-www-form-urlencoded
client_id (text): The unique identifier for the client application requesting the token.
\nclient_secret (text): The secret key associated with the client application, used for authentication.
\nscope (text): A space-separated list of scopes that define the access level requested by the client.
\ngrant_type (text): The type of grant being requested.
\nStatus Code: 200
Content-Type: application/json
access_token: The token that can be used to authenticate subsequent API requests.
\nexpires_in: The duration in seconds for which the access token is valid.
\ntoken_type: The type of token returned, typically \"Bearer\".
\nscope: The scopes that the access token is granted for.
\nEnsure that the client_id and client_secret are kept confidential to maintain security.
The access token should be included in the Authorization header of subsequent requests to access protected resources.
\nThe expires_in value indicates how long the token is valid; clients should handle token expiration appropriately.
/oauth/token
\nRegistered clients may request credentials through this endpoint.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"554783f0-cf98-4ebb-8079-bc4d3c94aa48"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cfd6dba9-25eb-4803-9857-6aa01387d4a3"}}],"_postman_id":"45e25295-ff0a-40bf-ae42-4f37a0c1819d","auth":{"type":"oauth2","oauth2":{"accessToken":"This endpoint is used to obtain an access token for authenticating API requests.
\nMake sure to handle the access token securely and refresh it as needed based on the expires_in value.
/oauth/token
Registered clients may request credentials through this endpoint. This endpoint may be removed in the future. If you are having trouble with OAuth 1.0 (legacy), please obtain your OAuth 2.0 credentials from the Flair App and switch to using OAuth 2.0 endpoints.
\nPlease note that this endpoint is subject to a rate limit of 50 requests per day. Exceeding this limit may result in requests being denied until the limit resets.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"caf397f2-6483-41af-870a-079b14b108fa"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5a56fa18-5aa1-4237-b9e9-902c65a31bce"}}],"_postman_id":"b2c4553b-ffe1-4eef-9e6e-10ee5848253d","auth":{"type":"oauth2","oauth2":{"accessToken":"There are two main ways to currently interact with Flair: Manual mode, and Auto mode. In Manual mode, all Vent operations must be controlled by the user, or a third party application. In Auto mode, Flair will automatically adjust Vents to achieve certain set points. Please check the mode first using the /structures endpoint, and evaluating the \"mode\" attribute.
\nManual mode:
\nIf the user's structure is using mode \"Manual\", then Vents will simply follow user commands or third party application commands. This mode is meant for testing devices easily, and for users who want direct, manual control over their devices.
\nIn manual mode, commands sent by third party applications will stay in effect until changed by either the user, or by the third party application.
\nFor instance, if your app wants complete control of whether Vent is open or closed, then set the structure mode to manual, and control the Vent position directly as shown below in section PATCH Open or Close a Vent.
\nAuto mode:
\nIf a user's structure has mode set to \"Auto\", then Flair will automatically adjust Vent positions to achieve the set points in the rooms. This mode is meant for users who want to set the temperature, and have Flair run. This mode is also the only mode that supports Flair scheduling and Flair Home/Away.
\nIn this mode, commands sent by third party applications or the user may be overwritten by the Flair Auto algorithm. For instance, a third party application may set the Vents in the bedroom to closed, but Flair will evaluate the temperature in that room, determine that it is too cold, and open the Vents again to let more heat in.
\nIn Auto mode, we suggest interacting with user structures by adjusting the room set points. Please see below under PATCH Adjust Room Set Point. This will tell Flair what set point to target, and Flair will adjust the Vents automatically.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f2c377ed-3037-4594-a693-3d14a22f5af0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1700160b-e20a-4086-a476-ec173a29cab1"}}],"_postman_id":"304a9f67-9660-40b6-a9c5-d958aa8db763","auth":{"type":"oauth2","oauth2":{"accessToken":"There are two main ways to currently interact with Flair: Manual mode, and Auto mode. In Manual mode, all minisplit operations must be controlled by the user, or a third party application. In Auto mode, Flair will automatically adjust minisplits to achieve certain set points. Please check the mode first using the /structures endpoint endpoint, and evaluating the \"mode\" attribute.
\nManual mode:
\nIf the user's structure is using mode \"Manual\", then minisplits will simply follow user commands or third party application commands. This mode is meant for testing devices easily, and for users who want direct, manual control over their devices.
\nIn manual mode, commands sent by third party applications will stay in effect until changed by either the user, or by the third party application.
\nIf your app wants complete control of what temperature, fan, swing, etc, a minisiplit is set to, then set the structure mode to manual, and control the minisplit directly as shown below in section PATCH Change Minisplit Settings.
\nAuto mode:
\nIf a user's structure has mode set to \"Auto\", then Flair will automatically adjust minisplit settings to achieve the set points in the rooms. This mode is meant for users who want to set the temperature, and have Flair run. This mode is also the only mode that supports Flair scheduling and Flair Home/Away.
\nIn this mode, commands sent by third party applications or the user may be overwritten by the Flair Auto algorithm. For instance, a third party application may set the minisplit in the bedroom set to 70, Cooling, but Flair will evaluate the temperature in that room, determine that it is too cold, and set it to 74, Heating.
\nIn Auto mode, we suggest interacting with user structures by adjusting the room set points. Please see below under PATCH Adjust Room Set Point. This way, your application can adjust the room set point, and Flair will automatically adjust the minisplit to follow the updated set point.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b9ccec74-9986-4e56-8d19-8765c2c3eb9b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"56ac66d9-6897-429d-9497-9ad6c4be6ab6"}}],"_postman_id":"ff426410-8ac9-4e3a-80ba-4e39f2b18f5e","auth":{"type":"oauth2","oauth2":{"accessToken":"Change the active schedule in a structure
\n","urlObject":{"protocol":"https","path":["api","structures","4351"],"host":["api","flair","co"],"query":[],"variable":[]}},"response":[{"id":"b1ae9637-238b-4666-b365-42637892e0d1","name":"Structure PATCH","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"structures\",\"attributes\":{\"active-schedule-id\":\"e569ca11-643d-499d-8090-c3e4902d1cb9\"}}}"},"url":"https://api.flair.co/api/structures/4351"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 14 Apr 2020 21:31:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Access-Control-Allow-Origin","value":"None"},{"key":"Access-Control-Max-Age","value":"21600"},{"key":"Access-Control-Allow-Headers","value":"authorization, content-type, accept, x-admin-mode, user-agent"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"self\": \"/api/structures/4351\"\n },\n \"data\": {\n \"type\": \"structures\",\n \"relationships\": {\n \"geofences\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/geofences\",\n \"related\": \"/api/structures/4351/geofences\"\n }\n },\n \"thermostats\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/thermostats\",\n \"related\": \"/api/structures/4351/thermostats\"\n }\n },\n \"zones\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/zones\",\n \"related\": \"/api/structures/4351/zones\"\n }\n },\n \"viewer-users\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/viewer-users\",\n \"related\": \"/api/structures/4351/viewer-users\"\n }\n },\n \"admin-users\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/admin-users\",\n \"related\": \"/api/structures/4351/admin-users\"\n }\n },\n \"hvac-units\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/hvac-units\",\n \"related\": \"/api/structures/4351/hvac-units\"\n }\n },\n \"remote-sensors\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/remote-sensors\",\n \"related\": \"/api/structures/4351/remote-sensors\"\n }\n },\n \"current-state\": {\n \"links\": {\n \"related\": \"/api/structures/4351/current-state\"\n },\n \"data\": {\n \"type\": \"structure-states\",\n \"id\": \"d53c3a13-b9a7-44f6-8140-fbf26b1391c5\"\n }\n },\n \"alerts\": {\n \"links\": {\n \"related\": \"/api/structures/4351/alerts\"\n }\n },\n \"supported-device-brands\": {\n \"links\": {\n \"related\": \"/api/structures/4351/supported-device-brands\"\n }\n },\n \"beacon-sightings\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/beacon-sightings\",\n \"related\": \"/api/structures/4351/beacon-sightings\"\n }\n },\n \"schedules\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/schedules\",\n \"related\": \"/api/structures/4351/schedules\"\n }\n },\n \"releases\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/releases\",\n \"related\": \"/api/structures/4351/releases\"\n }\n },\n \"default-zone\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/default-zone\",\n \"related\": \"/api/structures/4351/default-zone\"\n }\n },\n \"occupancy-conclusions\": {\n \"links\": {\n \"related\": \"/api/structures/4351/occupancy-conclusions\"\n }\n },\n \"editor-users\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/editor-users\",\n \"related\": \"/api/structures/4351/editor-users\"\n }\n },\n \"integration-structures\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/integration-structures\",\n \"related\": \"/api/structures/4351/integration-structures\"\n }\n },\n \"rooms\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/rooms\",\n \"related\": \"/api/structures/4351/rooms\"\n }\n },\n \"pucks\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/pucks\",\n \"related\": \"/api/structures/4351/pucks\"\n }\n },\n \"current-weather\": {\n \"links\": {\n \"related\": \"/api/structures/4351/current-weather\"\n }\n },\n \"invitations\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/invitations\",\n \"related\": \"/api/structures/4351/invitations\"\n }\n },\n \"weather-readings\": {\n \"links\": {\n \"related\": \"/api/structures/4351/weather-readings\"\n }\n },\n \"vents\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/vents\",\n \"related\": \"/api/structures/4351/vents\"\n }\n },\n \"active-schedule\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/active-schedule\",\n \"related\": \"/api/structures/4351/active-schedule\"\n },\n \"data\": {\n \"type\": \"schedules\",\n \"id\": \"e569ca11-643d-499d-8090-c3e4902d1cb9\"\n }\n },\n \"geofence-events\": {\n \"links\": {\n \"self\": \"/api/structures/4351/relationships/geofence-events\",\n \"related\": \"/api/structures/4351/geofence-events\"\n }\n },\n \"current-conclusions\": {\n \"links\": {\n \"related\": \"/api/structures/4351/current-conclusions\"\n }\n },\n \"structure-states\": {\n \"links\": {\n \"related\": \"/api/structures/4351/structure-states\"\n }\n }\n },\n \"attributes\": {\n \"mode\": \"auto\",\n \"setup-mode\": false,\n \"hysteresis-b\": 200,\n \"hysteresis-heat-cool-mode\": 300,\n \"structure-heat-cool-mode-popup-resolved-at\": null,\n \"temp-away-min-c\": 12.2,\n \"structure-heat-cool-mode\": \"cool\",\n \"home-away-mode\": \"Manual\",\n \"name\": \"My Home\",\n \"puck-client-id\": \"HhodCMXGiM3rPzvkpJ6O8Pcuzb4kLKSMMDfeZF2Z\",\n \"setup-complete\": true,\n \"setup-mode-first-time\": true,\n \"hold-reason\": null,\n \"longitude\": -122.408842,\n \"updated-at\": \"2020-04-14T21:31:03.633676+00:00\",\n \"state-updated-at\": \"2020-04-14T21:31:03.631447+00:00\",\n \"hold-until-schedule-event\": true,\n \"set-point-mode\": \"Home Evenness For Active Rooms Flair Setpoint\",\n \"structure-heat-cool-mode-calculated\": null,\n \"setup-step\": \"step-five-puck\",\n \"use-remote-sensor-occupancy\": null,\n \"preheat-precool\": false,\n \"frozen-pipe-pet-protect\": true,\n \"home\": true,\n \"active-schedule-id\": \"e569ca11-643d-499d-8090-c3e4902d1cb9\",\n \"location\": \"684 Peralta Ave\",\n \"puck-client-secret\": \"q2nYKegoHIz0GQvBcRFj6mQMwHRC3nmDOJAJeVXzKaWBCxTaj5oSv5gabp2v\",\n \"country\": \"US\",\n \"temperature-scale\": \"F\",\n \"latitude\": 37.741657,\n \"created-at\": \"2018-03-09T23:44:02.180249+00:00\",\n \"hold-until\": null,\n \"default-hold-duration\": \"Until\",\n \"release-channel\": \"production\",\n \"humidity-away-max\": 80,\n \"structure-away-mode\": \"Off Only\",\n \"state\": \"CA\",\n \"reporting-gateway\": true,\n \"set-point-temperature-c\": 20.56,\n \"is-active\": false,\n \"time-zone\": \"America/Los_Angeles\",\n \"location-type\": \"address\",\n \"hysteresis-a\": 50,\n \"structure-type\": null,\n \"city\": \"San Francisco\",\n \"licensed-features\": [],\n \"temp-away-max-c\": 30.9,\n \"humidity-away-min\": 10,\n \"zip-code\": \"94110\"\n },\n \"id\": \"4351\"\n }\n}"}],"_postman_id":"85b85bcc-02eb-4fba-a9ac-a9fb0e4327f0"}],"id":"ca663d78-0c97-4943-b535-9d542db54c25","description":"You can change settings in a Flair home by sending a PATCH to structure attributes.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"27d51a04-4699-46d5-9fd1-6cf7ddef748e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"bf3e9927-6d4c-421a-8946-28aa9df5b668"}}],"_postman_id":"ca663d78-0c97-4943-b535-9d542db54c25","auth":{"type":"oauth2","oauth2":{"accessToken":"Triggers that would execute a callback:
\nStructure Mode Change
\nRoom Set Point Change
\nRoom Active/Inactive Change
\nRoom Temperature / Humidity Change
\nheat_cool_mode can be either:
- COOL (if cooling)
- HEAT (if heating)
- FLOAT (if idle/off)
structure_heat_cool_mode can be either:
- COOL (if desire to cool)
- HEAT (if desire to heat)
- AUTO (to determine the ideal mode automatically)
- FLOAT (to have everything turned off/idle)
If you have multiple structures, you may want to append a query (?structure=1234), or similar method, to be able to identify what structure a callback is originating from.
\n{\"room_id\": 7821, \"heat_cool_mode\": \"COOL\", \"structure_heat_cool_mode\": \"AUTO\", \"occupied\": true, \"set_point\": 16.67, \"temperature\": 22.153938888888888, \"humidity\": 39.5}\n\nThe /users endpoint provides user information, such as name, email, and user preferences for Fahrenheit or Celsius.
\n","urlObject":{"protocol":"https","path":["api","users"],"host":["api","flair","co"],"query":[],"variable":[]}},"response":[{"id":"d3d607fa-a180-49ed-a190-485b43bb954f","name":"Users","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://api.flair.co/api/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"authorization, content-type, accept, x-admin-mode"},{"key":"Access-Control-Allow-Origin","value":"None"},{"key":"Access-Control-Max-Age","value":"21600"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Length","value":"2037"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"users\",\n \"attributes\": {\n \"name\": \"flairtest0001@flair.co\",\n \"created-at\": \"2018-02-08T17:46:41.598046+00:00\",\n \"firmware-emails\": true,\n \"updated-at\": \"2018-02-10T00:48:40.215445+00:00\",\n \"betas\": [\n \"flair-setpoint\",\n \"active-rooms\",\n \"honeywell-lyric\",\n \"third-party\"\n ],\n \"email\": \"flairtest0001@flair.co\",\n \"default-temperature-preference-c\": 22.5,\n \"role\": \"user\",\n \"temperature-scale\": \"F\",\n \"alert-emails\": true\n },\n \"id\": \"1859\",\n \"relationships\": {\n \"structures\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/structures\",\n \"related\": \"/api/users/1859/structures\"\n }\n },\n \"default-structure\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/default-structure\",\n \"related\": \"/api/users/1859/default-structure\"\n },\n \"data\": {\n \"type\": \"structures\",\n \"id\": \"4351\"\n }\n },\n \"unassigned-pucks\": {\n \"links\": {\n \"related\": \"/api/users/1859/unassigned-pucks\"\n },\n \"data\": []\n },\n \"received-invitations\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/received-invitations\",\n \"related\": \"/api/users/1859/received-invitations\"\n }\n },\n \"adminable-structures\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/adminable-structures\",\n \"related\": \"/api/users/1859/adminable-structures\"\n }\n },\n \"integrations\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/integrations\",\n \"related\": \"/api/users/1859/integrations\"\n }\n },\n \"viewable-structures\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/viewable-structures\",\n \"related\": \"/api/users/1859/viewable-structures\"\n }\n },\n \"editable-structures\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/editable-structures\",\n \"related\": \"/api/users/1859/editable-structures\"\n }\n },\n \"primary-device\": {\n \"links\": {\n \"self\": \"/api/users/1859/relationships/primary-device\",\n \"related\": \"/api/users/1859/primary-device\"\n },\n \"data\": null\n },\n \"devices\": {\n \"links\": {\n \"related\": \"/api/users/1859/devices\"\n }\n },\n \"puck-oauth-apps\": {\n \"links\": {\n \"related\": \"/api/users/1859/puck-oauth-apps\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"self\": \"/api/users\",\n \"first\": \"/api/users?page%5Bsize%5D=50&page%5Bpage%5D=1\",\n \"last\": \"/api/users?page%5Bsize%5D=50&page%5Bpage%5D=1\",\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"160e8181-76b1-4241-a390-9868af77adf0"},{"name":"Structures","id":"3366b193-a4b1-4ee9-81f2-ae1cccb6b471","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"The /structures endpoint shows the user's main home ID, in this case, 4351. The structure object shows information such as home name, address, temperature preferences, preferred hysteresis bounds, away mode, set point mode. More importantly, this endpoint provides links to find all of the rooms, Pucks, Vents, thermostats, and minisplits associated with this home.
\nFor third party applications, the most useful items to note are:
\nThis endpoint lists out all the rooms associated with a home. The main parameters are:
\nYou can use the API to adjust a room set point by setting set-point-c to a Celsius value. The link to use should be api/rooms/[ROOM_ID]. See the attached example on how to structure the JSON body. There is also a hold-until parameter to designate how long the hold should last for.
\nIMPORTANT: Please make sure structure mode is set to \"auto\". In \"auto\" mode, Flair will adjust Vents or minisplits to match the room set point. If not in \"auto\" mode, there will be no further action.
\n","urlObject":{"protocol":"https","path":["api","rooms","8310"],"host":["api","flair","co"],"query":[],"variable":[]}},"response":[{"id":"ce9c60d4-09d2-4825-a043-2d78ba078512","name":"Adjust Room Set Point","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"rooms\",\n \"attributes\": {\n \"set-point-c\": 24.00,\n \"hold-unitl\": \"2018-12-17T23:42:49.311698+00:00\"\n },\n \"relationships\": {}\n }\n}"},"url":"https://api.flair.co/api/rooms/8310"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"authorization, content-type, accept, x-admin-mode"},{"key":"Access-Control-Allow-Origin","value":"None"},{"key":"Access-Control-Max-Age","value":"21600"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Length","value":"2455"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"rooms\",\n \"attributes\": {\n \"preheat-precool\": true,\n \"frozen-pipe-pet-protect\": true,\n \"current-humidity\": 61,\n \"current-temperature-c\": 20.1266666666667,\n \"updated-at\": \"2018-12-17T23:18:03.680571+00:00\",\n \"pucks-inactive\": \"Active\",\n \"set-point-manual\": true,\n \"humidity-away-max\": 80,\n \"hold-reason\": \"ApiSetPointC\",\n \"occupancy-mode\": \"Flair Auto\",\n \"temp-away-max-c\": 22.5,\n \"name\": \"Bedroom\",\n \"windows\": null,\n \"room-away-mode\": \"Smart Away\",\n \"created-at\": \"2018-11-09T18:47:10.089676+00:00\",\n \"air-return\": false,\n \"set-point-c\": 24,\n \"hold-until\": \"2018-12-18T02:18:02.724772+00:00\",\n \"humidity-away-min\": 10,\n \"level\": null,\n \"temp-away-min-c\": 16,\n \"room-type\": null,\n \"active\": true\n },\n \"relationships\": {\n \"remote-sensors\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/remote-sensors\",\n \"related\": \"/api/rooms/8310/remote-sensors\"\n },\n \"data\": []\n },\n \"pucks\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/pucks\",\n \"related\": \"/api/rooms/8310/pucks\"\n },\n \"data\": [\n {\n \"type\": \"pucks\",\n \"id\": \"46eb5eef-7324-5748-2384-3f9ff8996373\"\n }\n ]\n },\n \"zones\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/zones\",\n \"related\": \"/api/rooms/8310/zones\"\n },\n \"data\": [\n {\n \"type\": \"zones\",\n \"id\": \"35940\"\n }\n ]\n },\n \"hvac-units\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/hvac-units\",\n \"related\": \"/api/rooms/8310/hvac-units\"\n },\n \"data\": [\n {\n \"type\": \"hvac-units\",\n \"id\": \"3b369fae-cc16-452c-80d8-4525e89efa42\"\n }\n ]\n },\n \"current-conclusions\": {\n \"links\": {\n \"related\": \"/api/rooms/8310/current-conclusions\"\n }\n },\n \"occupants\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/occupants\",\n \"related\": \"/api/rooms/8310/occupants\"\n }\n },\n \"occupancy-conclusions\": {\n \"links\": {\n \"related\": \"/api/rooms/8310/occupancy-conclusions\"\n }\n },\n \"puck-apps\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/puck-apps\",\n \"related\": \"/api/rooms/8310/puck-apps\"\n }\n },\n \"structure\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/structure\",\n \"related\": \"/api/rooms/8310/structure\"\n },\n \"data\": {\n \"type\": \"structures\",\n \"id\": \"4351\"\n }\n },\n \"thermostat\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/thermostat\",\n \"related\": \"/api/rooms/8310/thermostat\"\n },\n \"data\": {\n \"type\": \"thermostats\",\n \"id\": null\n }\n },\n \"room-states\": {\n \"links\": {\n \"related\": \"/api/rooms/8310/room-states\"\n }\n },\n \"room-auto-conclusions\": {\n \"links\": {\n \"related\": \"/api/rooms/8310/room-auto-conclusions\"\n }\n },\n \"vents\": {\n \"links\": {\n \"self\": \"/api/rooms/8310/relationships/vents\",\n \"related\": \"/api/rooms/8310/vents\"\n },\n \"data\": []\n }\n },\n \"id\": \"8310\"\n },\n \"meta\": {\n \"self\": \"/api/rooms/8310\"\n }\n}"}],"_postman_id":"82c81f39-f270-4eb2-a48f-2c6170c63933"},{"name":"Pucks","id":"95f3da1f-99f0-4bce-a8e5-0031ebab4fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"The Puck endpoint lists all the Flair Pucks associated with the home. Useful parameters are:
\nThe Puck endpoint will have a link to the Puck current-reading endpoint. Here you will find the latest set of sensor readings for this device, with additional information such as:
\nThe vents endpoint lists all associated Vents in the home. The most useful parameters are:
\nThe Vent endpoint will have a link to the Vent current-reading endpoint. Here you will find the latest set of sensor readings for this device, with information such as:
\nYou can use the API to open and close a vent by setting percent-open to 100 or 0, respectively. The link to use should be api/vents/[VENT_ID]. See the attached example on how to structure the JSON body.
\nIMPORTANT: Please make sure structure mode is set to \"manual\". In \"auto\" mode, Flair will automatically adjust Vents to match the room set point, so your Vent command will get overwritten. In \"manual\" mode, there will be no further changes to the Vent position unless application or user makes an adjustment.
\n","urlObject":{"protocol":"https","path":["api","vents","13c44351-5883-5cbe-52cf-da0c1a1505f7"],"host":["api","flair","co"],"query":[],"variable":[]}},"response":[{"id":"f75b8938-d365-45eb-9fd1-9d22b8166a14","name":"Open or Close a Vent","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"vents\",\n \"attributes\": {\n \"percent-open\": 100\n },\n \"relationships\": {}\n }\n}"},"url":"https://api.flair.co/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"authorization, content-type, accept, x-admin-mode"},{"key":"Access-Control-Allow-Origin","value":"None"},{"key":"Access-Control-Max-Age","value":"21600"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Length","value":"1220"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"vents\",\n \"relationships\": {\n \"closest-puck\": {\n \"links\": {\n \"related\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/closest-pucks\"\n }\n },\n \"structure\": {\n \"links\": {\n \"self\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/relationships/structure\",\n \"related\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/structure\"\n },\n \"data\": {\n \"type\": \"structures\",\n \"id\": \"4351\"\n }\n },\n \"vent-states\": {\n \"links\": {\n \"related\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/vent-states\"\n }\n },\n \"room\": {\n \"links\": {\n \"self\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/relationships/room\",\n \"related\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/room\"\n },\n \"data\": {\n \"type\": \"rooms\",\n \"id\": \"8704\"\n }\n },\n \"current-state\": {\n \"links\": {\n \"related\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/current-state\"\n }\n },\n \"sensor-readings\": {\n \"links\": {\n \"related\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7/sensor-readings\"\n }\n }\n },\n \"attributes\": {\n \"created-at\": \"2017-08-03T01:06:38.367916+00:00\",\n \"name\": \"Office Vent\",\n \"setup-lightstrip\": 1,\n \"inactive\": false,\n \"percent-open\": 100,\n \"updated-at\": \"2018-12-17T23:16:44.130172+00:00\"\n },\n \"id\": \"13c44351-5883-5cbe-52cf-da0c1a1505f7\"\n },\n \"meta\": {\n \"self\": \"/api/vents/13c44351-5883-5cbe-52cf-da0c1a1505f7\"\n }\n}"}],"_postman_id":"5efedb8c-21b2-47ac-a9fb-6ffa469badfa"},{"name":"Thermostats","id":"7f78c7c6-e713-4567-9227-7a456d48b592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"The thermostats endpoint lists the thermostats associated with the home. The important parameters are the \"name\", as well as \"static-vents\". The number of static vents is a user-provided estimate of how many vents (both Flair and non-Flair) are serviced by this thermostat.
\n","urlObject":{"protocol":"https","path":["api","thermostats"],"host":["api","flair","co"],"query":[],"variable":[]}},"response":[{"id":"19f33e3c-03e3-41a2-94bb-9c5e9c344b63","name":"Thermostats","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://api.flair.co/api/thermostats"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"authorization, content-type, accept, x-admin-mode"},{"key":"Access-Control-Allow-Origin","value":"None"},{"key":"Access-Control-Max-Age","value":"21600"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Length","value":"3680"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"thermostats\",\n \"relationships\": {\n \"structure\": {\n \"links\": {\n \"self\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/relationships/structure\",\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/structure\"\n },\n \"data\": {\n \"type\": \"structures\",\n \"id\": \"4351\"\n }\n },\n \"remote-sensor\": {\n \"links\": {\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/remote-sensor\"\n }\n },\n \"integration-structure\": {\n \"links\": {\n \"self\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/relationships/integration_structures\",\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/integration_structures\"\n },\n \"data\": {\n \"type\": \"integration-structures\",\n \"id\": \"ed85df89-2fcc-4e19-a6e3-1dd47cf13294\"\n }\n },\n \"room\": {\n \"links\": {\n \"self\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/relationships/room\",\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/room\"\n },\n \"data\": {\n \"type\": \"rooms\",\n \"id\": \"8844\"\n }\n },\n \"thermostat-states\": {\n \"links\": {\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/thermostat-states\"\n }\n },\n \"current-state\": {\n \"links\": {\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/current-state\"\n }\n },\n \"zone\": {\n \"links\": {\n \"self\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/relationships/zone\",\n \"related\": \"/api/thermostats/1c118d41-ea4d-406a-87c6-990cc0478bf5/zone\"\n },\n \"data\": {\n \"type\": \"zones\",\n \"id\": \"35941\"\n }\n }\n },\n \"attributes\": {\n \"source-id\": \"UyjfvFApM1H-1m3bZDb-4JHVt2k_js9E\",\n \"thermostat-model\": null,\n \"created-at\": \"2018-12-17T21:42:20.450662+00:00\",\n \"capabilities\": \"Both\",\n \"disabled\": false,\n \"name\": \"Upstairs Thermostat\",\n \"enable-room-tile-set-point-adjust\": true,\n \"make\": \"nest\",\n \"static-vents\": 16,\n \"updated-at\": \"2018-12-17T21:43:19.482052+00:00\"\n },\n \"id\": \"1c118d41-ea4d-406a-87c6-990cc0478bf5\"\n },\n {\n \"type\": \"thermostats\",\n \"relationships\": {\n \"structure\": {\n \"links\": {\n \"self\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/relationships/structure\",\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/structure\"\n },\n \"data\": null\n },\n \"remote-sensor\": {\n \"links\": {\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/remote-sensor\"\n }\n },\n \"integration-structure\": {\n \"links\": {\n \"self\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/relationships/integration_structures\",\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/integration_structures\"\n },\n \"data\": {\n \"type\": \"integration-structures\",\n \"id\": \"5da88405-068c-4ac8-bfc9-4718450aa64d\"\n }\n },\n \"room\": {\n \"links\": {\n \"self\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/relationships/room\",\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/room\"\n },\n \"data\": null\n },\n \"thermostat-states\": {\n \"links\": {\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/thermostat-states\"\n }\n },\n \"current-state\": {\n \"links\": {\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/current-state\"\n }\n },\n \"zone\": {\n \"links\": {\n \"self\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/relationships/zone\",\n \"related\": \"/api/thermostats/56e38150-8da8-48e0-a467-3235fbd4932a/zone\"\n },\n \"data\": {\n \"type\": \"zones\",\n \"id\": \"9494\"\n }\n }\n },\n \"attributes\": {\n \"source-id\": \"511829661106\",\n \"thermostat-model\": \"apolloSmart\",\n \"created-at\": \"2018-02-13T06:00:56.835670+00:00\",\n \"capabilities\": \"Both\",\n \"disabled\": false,\n \"name\": \"Ecobeeeee\",\n \"enable-room-tile-set-point-adjust\": null,\n \"make\": \"ecobee\",\n \"static-vents\": null,\n \"updated-at\": \"2018-02-13T06:00:56.853091+00:00\"\n },\n \"id\": \"56e38150-8da8-48e0-a467-3235fbd4932a\"\n }\n ],\n \"meta\": {\n \"self\": \"/api/thermostats\",\n \"first\": \"/api/thermostats?page%5Bsize%5D=50&page%5Bpage%5D=1\",\n \"last\": \"/api/thermostats?page%5Bsize%5D=50&page%5Bpage%5D=1\",\n \"next\": null,\n \"prev\": null\n }\n}"}],"_postman_id":"7f78c7c6-e713-4567-9227-7a456d48b592"},{"name":"HVAC-Units","id":"4f2f09fc-d7fc-418f-a84e-e84847e97484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"The HVAC-Units endpoint shows the current state of the minisplit, as well as the possible states supported by this minisplit. HVAC-Unit and minisplit are both terms referring to the same thing and is used interchangeably.
\nThe attributes are:
\nUse PATCH commands to api/hvac-units/[HVACUNIT_ID] to adjust minisplit settings. See the attached example on how to structure the JSON body. Power can be \"On\" or \"Off\". Mode is \"Heat\" or \"Cool\". Fan speed is \"High\", \"Mid\", \"Low\". Swing is either \"On\" or \"Off\". Temperature may only be the same units as listed in the constraints field. If the constraints are in Fahrenheit, please only send Fahrenheit requests, and vice versa.
\nIMPORTANT: Please make sure structure mode is set to \"manual\". In \"auto\" mode, Flair will automatically adjust minisplits to match the room set point, so your minisplit command will get overwritten. In \"manual\" mode, there will be no further changes to the minisplit settings unless application or user makes an adjustment.
\nIMPORTANT: Please check the constraints field to determine what states are allowable, as well as if you need to use Fahrenheit or Celsius. If you provide a state that is not support in the contraints object, Flair will do it's best to find the closest fit. To ensure deterministic behavior, please follow the constraints closely.
\n","urlObject":{"protocol":"https","path":["api","hvac-units","d5edfafc-34d2-4096-9519-b2280288f855"],"host":["api","flair","co"],"query":[],"variable":[]}},"response":[{"id":"9ebc5d59-3efa-42c7-bc7a-84b59c119ec2","name":"Change Minisplit Settings","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"hvac-units\",\n \"attributes\": {\n \"temperature\": 70,\n \"fan-speed\": \"High\"\n },\n \"relationships\": {}\n }\n}"},"url":"https://api.flair.co/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"authorization, content-type, accept, x-admin-mode"},{"key":"Access-Control-Allow-Origin","value":"None"},{"key":"Access-Control-Max-Age","value":"21600"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Length","value":"4188"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"hvac-units\",\n \"attributes\": {\n \"swing-auto\": true,\n \"make-id\": \"a3a2ea6d-4ebf-4357-98c3-21f18b567b44\",\n \"codeset-id\": \"ab48bedc-069c-46e6-bc3c-9a48bbad3d5b\",\n \"quiet-hours-end\": null,\n \"quiet-hours-start\": null,\n \"power\": \"On\",\n \"temperature-compensation\": \"THIRD PARTY\",\n \"codesets\": [\n {\n \"id\": 11,\n \"codeset-id\": \"ab48bedc-069c-46e6-bc3c-9a48bbad3d5b\",\n \"capabilities\": \"Both\",\n \"rank\": 1\n }\n ],\n \"to-download\": false,\n \"name\": \"New HVAC Device\",\n \"constraints\": {\n \"ON\": {\n \"DRY\": {\n \"OFF\": {\n \"FAN AUTO\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ]\n }\n },\n \"FAN\": {\n \"OFF\": {\n \"FAN HI\": [\n \"--\"\n ],\n \"FAN LOW\": [\n \"--\"\n ],\n \"FAN MID\": [\n \"--\"\n ],\n \"FAN AUTO\": [\n \"--\"\n ]\n }\n },\n \"AUTO\": {\n \"OFF\": {\n \"FAN AUTO\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ]\n }\n },\n \"COOL\": {\n \"OFF\": {\n \"FAN HI\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ],\n \"FAN LOW\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ],\n \"FAN MID\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ],\n \"FAN AUTO\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ]\n }\n },\n \"HEAT\": {\n \"OFF\": {\n \"FAN HI\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ],\n \"FAN LOW\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ],\n \"FAN MID\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ],\n \"FAN AUTO\": [\n \"62\",\n \"63\",\n \"64\",\n \"65\",\n \"66\",\n \"67\",\n \"68\",\n \"69\",\n \"70\",\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\",\n \"76\",\n \"77\",\n \"78\",\n \"79\",\n \"80\",\n \"81\",\n \"82\",\n \"83\",\n \"84\",\n \"85\",\n \"86\"\n ]\n }\n }\n },\n \"OFF\": {\n \"AUTO\": {\n \"OFF\": {\n \"FAN AUTO\": [\n \"72\"\n ]\n }\n }\n },\n \"temperature-scale\": \"F\"\n },\n \"fan-speed\": \"High\",\n \"temperature\": 70,\n \"ir-device-model-id\": null,\n \"swing\": \"Off\",\n \"incremental\": false,\n \"make-name\": \"LENNOX\",\n \"mode\": \"Heat\",\n \"button-presses\": [],\n \"model-id\": \"2efdce3c-4034-4901-96ca-cdecd546b3d4\",\n \"capabilities\": \"Both\",\n \"type\": \"MiniSplit\",\n \"default-fan-speed\": \"AUTO\"\n },\n \"relationships\": {\n \"hvac-unit-states\": {\n \"links\": {\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/hvac-unit-states\"\n }\n },\n \"puck\": {\n \"links\": {\n \"self\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/relationships/puck\",\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/puck\"\n },\n \"data\": {\n \"type\": \"pucks\",\n \"id\": \"46eb5eef-7324-5748-2384-3f9ff8996373\"\n }\n },\n \"room\": {\n \"links\": {\n \"self\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/relationships/room\",\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/room\"\n },\n \"data\": {\n \"type\": \"rooms\",\n \"id\": \"8310\"\n }\n },\n \"make\": {\n \"links\": {\n \"self\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/relationships/make\",\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/make\"\n }\n },\n \"zone\": {\n \"links\": {\n \"self\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/relationships/zone\",\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/zone\"\n },\n \"data\": {\n \"type\": \"zones\",\n \"id\": \"35940\"\n }\n },\n \"structure\": {\n \"links\": {\n \"self\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/relationships/structure\",\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/structure\"\n },\n \"data\": {\n \"type\": \"structures\",\n \"id\": \"4351\"\n }\n },\n \"current-state\": {\n \"links\": {\n \"related\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42/current-state\"\n },\n \"data\": {\n \"type\": \"hvac-unit-states\",\n \"id\": \"ce1d512c-20af-478e-90fe-ab97f0628761\"\n }\n }\n },\n \"id\": \"3b369fae-cc16-452c-80d8-4525e89efa42\"\n },\n \"meta\": {\n \"self\": \"/api/hvac-units/3b369fae-cc16-452c-80d8-4525e89efa42\"\n }\n}"}],"_postman_id":"fe425e22-bc80-4ca0-a909-e25257025d9d"},{"name":"Bridges","id":"596214b5-c354-4e9d-9439-5bc2ea20fc15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"tokenType":"The Bridge endpoint lists all the Flair Bridges associated with the home. Useful parameters are:
\nname: the Flair-generated name of the Bridge
\ncurrent-rssi: the current 915MHz radio signal strength
\ndisplay-number: the 4-character code identifying this bridge during setup
\nled-brightness: the brightness level of the Bridge LEDs
\nThe Bridge endpoint will have a link to the Bridge current-reading endpoint. Here you will find the latest set of sensor readings for this device, with information such as:
\ncreated_at: date and time of this reading, in GMT
\ndie-temperature: not currently implemented
\nrssi: the WiFi radio signal strength (integer). 0 if Bridge is connected via Ethernet
\nsystem-voltage: not currently implemented
\nThe following section is a reference of all Flair API endpoints, and their associated data.
\n","_postman_id":"525999d7-48dd-4d17-a3f1-f09a3581cbb9","auth":{"type":"oauth2","oauth2":{"accessToken":"