{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.evolo.no" } ], "info": { "name": "Evolo API Documentation", "_postman_id": "d62ca354-fae5-49e9-bb57-7ca7836bd5a2", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Sites", "description": "", "item": [ { "name": "List Sites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sites", "query": [ { "key": "search", "value": "Demo Site", "description": "Search by display name.", "disabled": false }, { "key": "per_page", "value": "100", "description": "Page size (default 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sites?search=Demo%20Site&per_page=100&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns paginated sites the authenticated user can access. Token must be scoped to at least one site." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"display_name\":\"Demo Site\"}],\"links\":{\"first\":\"http:\/\/example.com\/api\/v1\/sites?page=1\",\"last\":\"http:\/\/example.com\/api\/v1\/sites?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"http:\/\/example.com\/api\/v1\/sites\",\"per_page\":100,\"to\":1,\"total\":1}}", "name": "" } ] } ] }, { "name": "Alarms", "description": "", "item": [ { "name": "List Alarms", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alarms", "query": [ { "key": "site_id", "value": "1", "description": "Filter to one site. Must match an existing stored value.", "disabled": false }, { "key": "status", "value": "active", "description": "Filter by active, resolved or all. Defaults to active.", "disabled": false }, { "key": "priority", "value": "", "description": "Filter by priority A, B or C.", "disabled": true }, { "key": "acknowledged", "value": "", "description": "Filter by acknowledgement state. Accepts true\/false or 1\/0.", "disabled": true }, { "key": "search", "value": "", "description": "Search alarm, trigger, or site names. Must not be greater than 255 characters.", "disabled": true }, { "key": "per_page", "value": "100", "description": "Page size (default 100). Must be at least 1. Must not be greater than 500.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/alarms?site_id=1&status=active&priority=&acknowledged=&search=&per_page=100" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of alarms the user can access. Defaults to active alarms.\n\nTo use this endpoint with an access token, the token must include the read:alarms ability and be scoped to at least one site." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"alarms\",\"id\":\"1337\",\"attributes\":{\"site\":{\"id\":1,\"display_name\":\"Building A\"},\"trigger\":{\"id\":42,\"display_name\":\"High supply temperature\",\"description\":null,\"priority\":\"A\",\"enabled\":true},\"status\":\"active\",\"source\":\"logger\",\"description\":\"Temperature above limit\",\"triggered_at\":\"2026-06-17T08:00:00+00:00\",\"resolved_at\":null,\"recovering_until\":null,\"acknowledged\":false,\"acknowledged_by\":null,\"acknowledged_message\":null,\"acknowledged_at\":null,\"last_active_event\":{\"id\":9001,\"source\":\"logger\",\"type\":\"Alarm\",\"triggered_on\":\"h\u00f8y\",\"value\":24.7,\"textlist_value\":null,\"triggered_at\":\"2026-06-17T08:00:00+00:00\"}}}],\"links\":{\"first\":\"https:\/\/api.evolo.no\/api\/v1\/alarms?page=1\",\"last\":\"https:\/\/api.evolo.no\/api\/v1\/alarms?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"https:\/\/api.evolo.no\/api\/v1\/alarms\",\"per_page\":100,\"to\":1,\"total\":1}}", "name": "" } ] } ] }, { "name": "Tags", "description": "", "item": [ { "name": "List Tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags", "query": [ { "key": "site_id", "value": "1", "description": "The site to list tags from.", "disabled": false }, { "key": "search", "value": "temp", "description": "Search by display name\/description\/hostinterface\/unit.", "disabled": false }, { "key": "system_id", "value": "1", "description": "Only tags belonging to this system (see List Systems).", "disabled": false }, { "key": "per_page", "value": "100", "description": "Page size (default 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tags?site_id=1&search=temp&system_id=1&per_page=100&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of tags the user can access in a given site.\nTo use this endpoint the access token must include the read:tags ability and be scoped to at least one site. If the user only has component permissions, tags are limited to those reachable via their views." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"tags\",\"id\":\"1337\",\"attributes\":{\"display_name\":\"Supply air temperature\",\"description\":null,\"unit\":\"\u00b0C\"}}],\"links\":{\"first\":\"http:\/\/example.com\/api\/v1\/tags?site_id=1&page=1\",\"last\":\"http:\/\/example.com\/api\/v1\/tags?site_id=1&page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"http:\/\/example.com\/api\/v1\/tags\",\"per_page\":100,\"to\":1,\"total\":1}}", "name": "" } ] }, { "name": "Read Tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags\/read", "query": [ { "key": "tags", "value": "1337,1338", "description": "The IDs of the tags.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tags\/read?tags=1337%2C1338" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the current value of the specified Tags.\n\nThe value can be a float, boolean, or null.\n\nIf the value is null, it indicates that the Evolo Gateway is unable to read the value from the selected Tag's device. This could occur, for instance, if Modbus\/BACnet timed out or the device is offline.\n\nRate: 20\/min. Max 20 tags per request.\n\nTo use this endpoint the access token must include the read:tags ability and be scoped to at least one site. Tags must belong to a site the user can access. If the user only has component permissions, access is limited to tags reachable via their views." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"tags\",\"id\":\"1337\",\"attributes\":{\"display_name\":\"Supply air temperature\",\"description\":null,\"unit\":\"\u00b0C\"},\"value\":23},{\"type\":\"tags\",\"id\":\"1338\",\"attributes\":{\"display_name\":\"Running status\",\"description\":null,\"unit\":null},\"value\":true}]}", "name": "" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 401, \"message\": \"Unauthenticated.\" }] }", "name": "Unauthorized" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 404, \"message\": \"The resource cannot be found.\" }] }", "name": "Not Found" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 422, \"message\": \"The tags field is required.\",\"source\":\"tags\" }] }", "name": "Unprocessable Entity" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 500, \"message\": \"An unexpected error occurred. Please try again later.\" }] }", "name": "Internal Server Error" } ] }, { "name": "Write Tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags\/write", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tags\/write" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[{\"tag_id\":\"1337\",\"value\":23.5},{\"tag_id\":\"1338\",\"value\":true}]}" }, "description": "Update the value of the specified Tags.\n\nThe value can be a float or boolean.\n\nRate: 20\/min. Max 20 tags per request.\n\nTo use this endpoint the access token must include the write:tags ability and be scoped to at least one site. Tags must belong to a site the user can access. If the user only has component permissions, access is limited to tags reachable via their views." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{ \"type\": \"tags\", \"id\": \"1337\", \"attributes\": { \"display_name\": \"Supply air temperature\", \"description\": null, \"unit\": \"\u00b0C\"}, \"value\": 23.5 }]}", "name": "" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 401, \"message\": \"Unauthenticated.\" }] }", "name": "Unauthorized" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 404, \"message\": \"The resource cannot be found.\" }] }", "name": "Not Found" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 422, \"message\": \"The tags field is required.\",\"source\":\"tags\" }] }", "name": "Unprocessable Entity" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 500, \"message\": \"An unexpected error occurred. Please try again later.\" }] }", "name": "Internal Server Error" } ] }, { "name": "Retrieve Tags History", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags\/history", "query": [ { "key": "tags", "value": "1337,1338", "description": "The IDs of the tags.", "disabled": false }, { "key": "from", "value": "2025-01-01T00:00:00Z", "description": "Start of the time range in ISO 8601 format with a trailing Z (UTC).", "disabled": false }, { "key": "to", "value": "2025-02-01T00:00:00Z", "description": "End of the time range in ISO 8601 format with a trailing Z (UTC).", "disabled": false }, { "key": "resolution", "value": "1d", "description": "The time interval for grouping or sampling data.", "disabled": false }, { "key": "tz", "value": "Europe\/Oslo", "description": "The IANA time zone to use for local alignment in aggregate queries.", "disabled": false }, { "key": "scalar", "value": "1", "description": "Set to 1 to return a single aggregated value per tag (last minus first over the period, e.g. total consumption) as \"value\" instead of the measurements series.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tags\/history?tags=1337%2C1338&from=2025-01-01T00%3A00%3A00Z&to=2025-02-01T00%3A00%3A00Z&resolution=1d&tz=Europe%2FOslo&scalar=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the logged history value of the specified Tags.\n\nThe value per measurement can be a float, boolean, or null.\n\nIf no log exists for the Tag, a 404 error will be returned.\n\nRate: 20\/min. Max 20 tags per request.\n\nTo use this endpoint the access token must include the `read:tags` ability and be scoped to a site that contains the requested tags. If the user only has component permissions, access is limited to tags reachable via their views.\n\nAll timestamps in the response are returned in UTC." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{ \"type\": \"logs\", \"id\": \"1337\", \"attributes\": { \"display_name\": \"Supply air temperature\", \"description\": null, \"unit\": \"\u00b0C\"}, \"measurements\": [{ \"timestamp\": \"2025-01-01T23:00:00Z\", \"value\": 21.4 }, { \"timestamp\": \"2025-01-02T23:00:00Z\", \"value\": 21.9 }]}]}", "name": "" }, { "header": [], "code": 200, "body": "{\"data\": [{ \"type\": \"logs\", \"id\": \"1338\", \"attributes\": { \"display_name\": \"Ventilation energy meter\", \"description\": null, \"unit\": \"kWh\"}, \"measurements\": [1843.5]}]}", "name": "Scalar" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 401, \"message\": \"Unauthenticated.\" }] }", "name": "Unauthorized" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 404, \"message\": \"The resource cannot be found. Please make sure all tags have logs.\", \"meta\": [] }] }", "name": "Not Found" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\":422, \"message\":\"The tags field is required.\",\"source\":\"tags\"},{\"status\":422,\"message\":\"The from field is required.\",\"source\":\"from\"},{\"status\":422,\"message\":\"The to field is required.\",\"source\":\"to\"},{\"status\":422,\"message\":\"The resolution field is required.\",\"source\":\"resolution\"},{\"status\":422,\"message\":\"The tz field is required.\",\"source\":\"tz\"}]}", "name": "Unprocessable Entity" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 504, \"message\": \"Could not retrieve historical data. Please try again later.\", \"meta\": [] }] }", "name": "Logger unavailable" }, { "header": [], "code": 200, "body": "{\"errors\": [{ \"status\": 500, \"message\": \"An unexpected error occurred. Please try again later.\" }] }", "name": "Internal Server Error" } ] } ] }, { "name": "General", "description": "", "item": [ { "name": "Healthcheck", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/healthcheck", "query": [], "raw": "{{baseUrl}}\/api\/v1\/healthcheck" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check that the service is up. If everything is okay, you'll get a 200 OK response.\n\nOtherwise, the request will fail with a 500 error listing the health status.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "max-age=0, must-revalidate, no-cache, no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "referrer-policy", "value": "no-referrer-when-downgrade" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-ratelimit-limit", "value": "20" }, { "key": "x-ratelimit-remaining", "value": "19" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"status\":\"healthy\",\"timestamp\":\"2026-10-06T23:46:49Z\"}", "name": "" }, { "header": [], "code": 503, "body": "{\"status\": \"unhealthy\", \"timestamp\": \"2024-09-01T12:00:00Z\"}", "name": "Service is unhealthy" } ] }, { "name": "Show Token Info", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Introspect the authenticated user and access token: which abilities the token has, which sites it is scoped to, and when it expires.\n\nUseful for debugging integrations that receive 403 responses." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"user\":{\"id\":1,\"name\":\"Jane Doe\",\"email\":\"jane@example.com\"},\"token\":{\"name\":\"Reader\",\"abilities\":[\"read:tags\",\"read:alarms\"],\"expires_at\":\"2027-01-01T00:00:00Z\",\"sites\":[{\"id\":1,\"display_name\":\"Demo Site\"}]}}}", "name": "" } ] } ] }, { "name": "Gateways", "description": "", "item": [ { "name": "List Gateways", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/gateways", "query": [ { "key": "site_id", "value": "1", "description": "The site to list gateways from.", "disabled": false }, { "key": "search", "value": "Gateway", "description": "Search by display name.", "disabled": false }, { "key": "per_page", "value": "100", "description": "Page size (default 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/gateways?site_id=1&search=Gateway&per_page=100&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of gateways in a given site.\n\nTo use this endpoint the access token must include the read:gateways ability and be scoped to at least one site. The user must also have permission to read gateways in the requested site." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"gateways\",\"id\":\"1337\",\"attributes\":{\"display_name\":\"Gateway Building A\",\"online\":true,\"version\":\"2.4.0\",\"hardware\":\"RPI4\",\"ip_address\":\"10.0.0.10\",\"location\":\"Plant room\"}}],\"links\":{\"first\":\"http:\/\/example.com\/api\/v1\/gateways?site_id=1&page=1\",\"last\":\"http:\/\/example.com\/api\/v1\/gateways?site_id=1&page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"http:\/\/example.com\/api\/v1\/gateways\",\"per_page\":100,\"to\":1,\"total\":1}}", "name": "" } ] } ] }, { "name": "Hosts", "description": "", "item": [ { "name": "List Hosts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts", "query": [ { "key": "site_id", "value": "1", "description": "The site to list hosts from.", "disabled": false }, { "key": "gateway_id", "value": "1", "description": "Filter to hosts under one gateway.", "disabled": false }, { "key": "search", "value": "Ventilation", "description": "Search by display name.", "disabled": false }, { "key": "per_page", "value": "100", "description": "Page size (default 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/hosts?site_id=1&gateway_id=1&search=Ventilation&per_page=100&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of hosts (devices) in a given site.\n\nTo use this endpoint the access token must include the read:hosts ability and be scoped to at least one site. The user must also have permission to read hosts in the requested site." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"hosts\",\"id\":\"1337\",\"attributes\":{\"display_name\":\"Ventilation 360.001\",\"description\":null,\"type\":\"VentilationSystem\",\"model_name\":\"Flexit Nordic\",\"ip\":\"10.0.0.20\",\"mac_address\":null,\"gateway\":{\"id\":1,\"display_name\":\"Gateway Building A\"}}}],\"links\":{\"first\":\"http:\/\/example.com\/api\/v1\/hosts?site_id=1&page=1\",\"last\":\"http:\/\/example.com\/api\/v1\/hosts?site_id=1&page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"http:\/\/example.com\/api\/v1\/hosts\",\"per_page\":100,\"to\":1,\"total\":1}}", "name": "" } ] } ] }, { "name": "Systems", "description": "", "item": [ { "name": "List Systems", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/systems", "query": [ { "key": "site_id", "value": "1", "description": "The site to list systems from.", "disabled": false }, { "key": "search", "value": "360.001", "description": "Search by code or display name.", "disabled": false }, { "key": "per_page", "value": "100", "description": "Page size (default 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/systems?site_id=1&search=360.001&per_page=100&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of FDV systems in a given site.\n\nTo use this endpoint the access token must include the read:systems ability and be scoped to at least one site. The user must also have permission to read FDV (documents) in the requested site." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"systems\",\"id\":\"1\",\"attributes\":{\"code\":\"360.001\",\"display_name\":\"Air Handling Unit A\",\"discipline\":\"Air handling\",\"description\":\"Rotary heat recovery, VAV control per zone.\",\"location\":\"Plant room, 9th floor\",\"manufacturer\":\"Swegon GOLD RX 35\",\"installed_year\":2019,\"maintenance_notes\":null,\"datapoints_count\":412}}],\"links\":{\"first\":\"http:\/\/example.com\/api\/v1\/systems?site_id=1&page=1\",\"last\":\"http:\/\/example.com\/api\/v1\/systems?site_id=1&page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"http:\/\/example.com\/api\/v1\/systems\",\"per_page\":100,\"to\":1,\"total\":1}}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }