This API exposes the Spaceti device and event flow infrastructure via a standard programmatic interface. It is a RESTful API based on HTTP requests and JSON responses.
\nThe easiest way to start using the Spaceti API is by clicking the Run in Postman button above. Postman is a free tool which helps developers run and debug API requests, and is the source of truth for this documentation.
\nFor authorization purposes API is using bearer token. You can get API token for your account in Spaceti dashboard. Navigate to Organization settings → Public API → Generate token.
\nValid token should be present in every request, in the header.
\nAuthorization: Bearer YOUR_TOKEN\n\nOur API uses a sliding window rate limiting algorithm, allowing up to 1,000 requests per 10-minute window. This helps ensure fair usage and system stability by tracking request counts dynamically over the last 10 minutes. Once the limit is reached, additional requests will be blocked, and API will return an HTTP 429 status code until the window resets. If you require a higher request limit, please contact us, and we'll work with you to accommodate your needs.
\nEndpoints that return multiple results paginate them to 100 items by default. You can set you desired size of the response using query string parameter page_size. The maximum page size is 500 items.
The root of these responses would contain count of the records on this page, URLs to the next and previous page. If there is no next or previous page the URL will be null
{\n \"next\": \"https://api.spaceti.net/v2/devices?next=00124B000D27C4E4\",\n \"previous\": null,\n \"count\": 100,\n \"records\": [\n ...\n ]\n}\n\nList devices associated with your account. This endpoint supports pagination.
\n","urlObject":{"path":["devices"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Optional - Allows you to sort records. Value that can be passed to the API consists of + or - sign that defines sorting order and name of the attribute to sort by.
Optional - Allows you to lookup for devices whose Serial Number starts with the value you specified.
\n","type":"text/plain"},"key":"starts_with","value":"Optional - Allows you to filter devices from the specific building.
\n","type":"text/plain"},"key":"building_id","value":"View information about the device.
\n","urlObject":{"path":["devices",":mac"],"host":["https://api.spaceti.net/v2"],"query":[],"variable":[{"description":{"content":"Device MAC address
\n","type":"text/plain"},"type":"any","value":"","key":"mac"}]}},"response":[{"id":"931b6c0b-d6e6-4d7e-aa04-4b16eb912056","name":"User is not authorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":{"raw":"https://api.spaceti.net/v2/devices/:mac","host":["https://api.spaceti.net/v2"],"path":["devices",":mac"],"variable":[{"key":"mac","value":"00124B001803BE4A","description":"Device MAC address"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.3"},{"key":"Date","value":"Tue, 16 Feb 2021 12:45:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"X-Amzn-Requestid","value":"70c0bf47-0d7a-4ec2-871c-5e227b1473c3"},{"key":"X-Amzn-Errortype","value":"AccessDeniedException"},{"key":"X-Amz-Apigw-Id","value":"a1qtvG6dFiAFcBw="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b3f1989dace51bd45b636bc99a604b20.cloudfront.net (CloudFront), 1.1 vegur"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"q-GxzL5d-a4ozF48qkl-MR2LH4bZmE-GoJzhgnugidVddeusV77lyw=="}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"User is not authorized to access this resource with an explicit deny\"\n}"},{"id":"e4b6a76b-1851-4157-b21a-43d17f57903f","name":"Get device by MAC address","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":{"raw":"https://api.spaceti.net/v2/devices/:mac","host":["https://api.spaceti.net/v2"],"path":["devices",":mac"],"variable":[{"key":"mac","value":"00124B001803BE4A","description":"Device MAC address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.3"},{"key":"Date","value":"Tue, 16 Feb 2021 12:44:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1603"},{"key":"X-Amzn-Requestid","value":"bd697eee-07af-4ee9-a7c3-5a5513860f6a"},{"key":"X-Amz-Apigw-Id","value":"a1qmpEKbliAFSdg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-602bbe2a-0c114087427618aa70ec3c44;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 2624e42a83112268605736034e2afc15.cloudfront.net (CloudFront), 1.1 vegur"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"ZwM1FzwswVo6c1ohpstP8k3QpVFGD74sktyDsRGg7on29rvYkoWUBw=="}],"cookie":[],"responseTime":null,"body":"{\n \"latest_service_info\": {\n \"gateway_info\": {\n \"rssi\": -68,\n \"gateway_sn\": \"9181001E20500003\"\n },\n \"counter\": 0,\n \"nb_info\": {\n \"ack\": 0,\n \"rsrp\": 0,\n \"snr\": 0,\n \"cell_id\": \"\",\n \"ecl\": 0\n },\n \"volt\": 3.6\n },\n \"location\": {\n \"overall_capacity\": 2,\n \"building_id\": 56,\n \"timezone\": \"Prague\",\n \"group_types\": [\n null,\n null\n ],\n \"spaces\": [\n 463,\n 463\n ],\n \"position\": [\n 14.439625475939728,\n 50.084438809269415\n ],\n \"coordinates\": [\n 17.2170839451441,\n 10.3950616002511\n ],\n \"groups\": [\n 156,\n 156\n ],\n \"floor_id\": 68,\n \"deployment_id\": 310,\n \"space_types\": [\n 4,\n 4\n ],\n \"tenant\": \"spacetihq\"\n },\n \"beacon_info\": {\n \"major\": 1,\n \"minor\": 1,\n \"uuid\": \"53706163-6574-6920-6279-20694c6162a9\",\n \"tx_power\": -57\n },\n \"mac\": \"00124B001803BE4A\",\n \"mnf_data\": {\n \"fixture_id\": 716,\n \"battery_voltage\": 3.303,\n \"nrf52_fw_version\": \"0.0.0\",\n \"rf_signal\": 0,\n \"power_consumption_sleep\": 0.00001162,\n \"cc1310_fw_version\": \"rfWsnNode_Roompir_1_6_3_8683_E6Z00.hex\",\n \"fixture_status\": \"OK\",\n \"voltage_3v3\": 3.309,\n \"power_consumption_transmit\": 0.000173,\n \"battery_2\": \"LS14500\",\n \"sim_iccid\": null,\n \"battery_1\": \"LS14500\",\n \"device_state\": \"mnf\",\n \"date_of_production\": \"2019-05-28\",\n \"ble_signal\": 0,\n \"vddr_voltage\": 1.657,\n \"power_consumption_peak\": 0.005814\n },\n \"tenant\": \"spacetihq\",\n \"updated_at\": 1612376592.267067756,\n \"changed_attribute\": null,\n \"manufacturer\": \"Spaceti\",\n \"device_type\": 6,\n \"partner\": \"Spaceti\",\n \"scan_enabled\": \"s\",\n \"sn\": \"SRP0L2P100N0000600\",\n \"occupancy\": {\n \"previous_measurement\": {\n \"request_id\": \"977b80b1-afdf-4151-898d-78d5f408bc09\",\n \"value\": 1,\n \"created_at\": 1613478928\n },\n \"type\": \"occupancy\",\n \"measurement\": {\n \"request_id\": \"3bde1dbe-b6c4-44d3-af4a-4434e48aac35\",\n \"value\": 1,\n \"created_at\": 1613478928\n },\n \"timezone\": \"Prague\",\n \"before_free_time\": 0\n }\n}"}],"_postman_id":"6f618ad1-55f9-4376-851d-52d97d610042"},{"name":"Get device by Serial Number","id":"5d7bed49-ad2d-4e4d-b7bf-058ef1b5c223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"https://api.spaceti.net/v2/devices/sn/:serial_number","description":"View information about the device.
\n","urlObject":{"path":["devices","sn",":serial_number"],"host":["https://api.spaceti.net/v2"],"query":[],"variable":[{"description":{"content":"Device Serial Number
\n","type":"text/plain"},"type":"any","value":"","key":"serial_number"}]}},"response":[{"id":"cca3a083-1362-4710-a493-4e2702b48c84","name":"User is not authorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":{"raw":"https://api.spaceti.net/v2/devices/sn/:serial_number","host":["https://api.spaceti.net/v2"],"path":["devices","sn",":serial_number"],"variable":[{"key":"serial_number","value":"SRP0L2P100N0000600","description":"Device Serial Number"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.3"},{"key":"Date","value":"Tue, 16 Feb 2021 12:47:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"X-Amzn-Requestid","value":"cdaabd28-bdf3-42b0-a8e9-a03d1bb45276"},{"key":"X-Amzn-Errortype","value":"AccessDeniedException"},{"key":"X-Amz-Apigw-Id","value":"a1q-6EuUliAFf7Q="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 4d362c0e30ca2cfa3855b041727beaa2.cloudfront.net (CloudFront), 1.1 vegur"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"mHHFRlE47GuwEJuNT2ICA6Gk6QTzN8-cJWyR4XoL24_7S9qAbLSd9A=="}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"User is not authorized to access this resource with an explicit deny\"\n}"},{"id":"fcd3bed3-0bde-4c96-bc8e-319dd3c3755c","name":"Get device by Serial Number","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":{"raw":"https://api.spaceti.net/v2/devices/sn/:serial_number","host":["https://api.spaceti.net/v2"],"path":["devices","sn",":serial_number"],"variable":[{"key":"serial_number","value":"SRP0L2P100N0000600","description":"Device Serial Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.3"},{"key":"Date","value":"Tue, 16 Feb 2021 12:46:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1603"},{"key":"X-Amzn-Requestid","value":"c3bb11a6-edf9-4441-a043-770aa1ee9b33"},{"key":"X-Amz-Apigw-Id","value":"a1q6CFQKFiAFZ8A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-602bbea6-05c9a4e357c54cbd727f41ab;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 df28c5139a58e7fd82c9f1801939f7c1.cloudfront.net (CloudFront), 1.1 vegur"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"2gZwCGlI5mWHZYVQLm_vxZp_6x0Nxv8IlXVZ1Y7QfNEAG37pVJjdLg=="}],"cookie":[],"responseTime":null,"body":"{\n \"latest_service_info\": {\n \"gateway_info\": {\n \"rssi\": -68,\n \"gateway_sn\": \"9181001E20500003\"\n },\n \"counter\": 0,\n \"nb_info\": {\n \"ack\": 0,\n \"rsrp\": 0,\n \"snr\": 0,\n \"cell_id\": \"\",\n \"ecl\": 0\n },\n \"volt\": 3.6\n },\n \"location\": {\n \"overall_capacity\": 2,\n \"building_id\": 56,\n \"timezone\": \"Prague\",\n \"group_types\": [\n null,\n null\n ],\n \"spaces\": [\n 463,\n 463\n ],\n \"position\": [\n 14.439625475939728,\n 50.084438809269415\n ],\n \"coordinates\": [\n 17.2170839451441,\n 10.3950616002511\n ],\n \"groups\": [\n 156,\n 156\n ],\n \"floor_id\": 68,\n \"deployment_id\": 310,\n \"space_types\": [\n 4,\n 4\n ],\n \"tenant\": \"spacetihq\"\n },\n \"beacon_info\": {\n \"major\": 1,\n \"minor\": 1,\n \"uuid\": \"53706163-6574-6920-6279-20694c6162a9\",\n \"tx_power\": -57\n },\n \"mnf_data\": {\n \"fixture_id\": 716,\n \"battery_voltage\": 3.303,\n \"nrf52_fw_version\": \"0.0.0\",\n \"rf_signal\": 0,\n \"power_consumption_sleep\": 0.00001162,\n \"cc1310_fw_version\": \"rfWsnNode_Roompir_1_6_3_8683_E6Z00.hex\",\n \"fixture_status\": \"OK\",\n \"voltage_3v3\": 3.309,\n \"power_consumption_transmit\": 0.000173,\n \"battery_2\": \"LS14500\",\n \"sim_iccid\": null,\n \"battery_1\": \"LS14500\",\n \"device_state\": \"mnf\",\n \"date_of_production\": \"2019-05-28\",\n \"ble_signal\": 0,\n \"vddr_voltage\": 1.657,\n \"power_consumption_peak\": 0.005814\n },\n \"mac\": \"00124B001803BE4A\",\n \"updated_at\": 1612376592.267067756,\n \"tenant\": \"spacetihq\",\n \"changed_attribute\": null,\n \"manufacturer\": \"Spaceti\",\n \"partner\": \"Spaceti\",\n \"device_type\": 6,\n \"sn\": \"SRP0L2P100N0000600\",\n \"scan_enabled\": \"s\",\n \"occupancy\": {\n \"previous_measurement\": {\n \"request_id\": \"977b80b1-afdf-4151-898d-78d5f408bc09\",\n \"value\": 1,\n \"created_at\": 1613478928\n },\n \"type\": \"occupancy\",\n \"measurement\": {\n \"request_id\": \"3bde1dbe-b6c4-44d3-af4a-4434e48aac35\",\n \"value\": 1,\n \"created_at\": 1613478928\n },\n \"timezone\": \"Prague\",\n \"before_free_time\": 0\n }\n}"}],"_postman_id":"5d7bed49-ad2d-4e4d-b7bf-058ef1b5c223"}],"id":"0ca2bbe9-dc6e-4e56-a570-bb7ff857865a","description":"Device is a physical sensor of any type that is registered in Spaceti system. Each sensor is automatically updated with the latest measurements it supports.
\nYou are getting access only to the devices associated with your account.
\nList gateways associated with your account. This endpoint supports pagination.
\n","urlObject":{"path":["gateways"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Optional - Allows you to sort records. Value that can be passed to the API consists of + or - sign that defines sorting order and name of the attribute to sort by.
Optional - Allows you to lookup for gateways whose Serial Number starts with the value you specified.
\n","type":"text/plain"},"key":"starts_with","value":"Optional - Allows you to filter devices from the specific building.
\n","type":"text/plain"},"key":"building_id","value":"View information about the gateway.
\n","urlObject":{"path":["gateways",":serial_number"],"host":["https://api.spaceti.net/v2"],"query":[],"variable":[{"description":{"content":"Gateway Serial Number
\n","type":"text/plain"},"type":"any","value":"","key":"serial_number"}]}},"response":[{"id":"d6b2d1aa-50d8-4db6-b4b2-3c9fd1702d79","name":"Get gateway by Serial Number","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":{"raw":"https://api.spaceti.net/v2/gateways/:serial_number","host":["https://api.spaceti.net/v2"],"path":["gateways",":serial_number"],"variable":[{"key":"serial_number","value":"SHU0L2V100N0362","description":"Gateway Serial Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.8"},{"key":"Date","value":"Thu, 29 Apr 2021 12:45:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"606"},{"key":"X-Amzn-Requestid","value":"8001aeea-a959-451e-8e63-d4970a93b57b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Amz-Apigw-Id","value":"ei-RlHIOliAFTxw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-608aaa70-4238962143befb253e3b5a24;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 699b505ca4c2135b52633ef9f9cd2ac0.cloudfront.net (CloudFront), 1.1 vegur"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"PppDlkh-O_21v4FK0zzxXaSKZ-AFjHEMX3RuQO6EhXx6qaEAJf47SA=="}],"cookie":[],"responseTime":null,"body":"{\n \"latest_service_info\": {\n \"sender\": {\n \"bytes_sent\": 175264,\n \"messages_sent\": 5331\n },\n \"ethernet_available\": false,\n \"vpn_available\": true,\n \"collector_available\": true,\n \"mobile_quality\": {\n \"rssi\": -49,\n \"network\": \"2G\"\n },\n \"keep_alive\": true,\n \"ethernet_data\": null,\n \"mobile_data\": {\n \"tx\": 411869,\n \"rx\": 85178\n },\n \"mobile_available\": true,\n \"uptime\": 17560,\n \"timestamp\": 1619699871\n },\n \"updated_at\": 1618059075,\n \"latest_event_at\": 1619700311,\n \"created_at\": 1618059075,\n \"manufacturer\": \"Spaceti\",\n \"mnf_data\": {\n \"eth_mac\": \"b827ebdc4b3d\",\n \"fw_version\": \"2.0.17 mobile\",\n \"mobile_modem\": {\n \"imei\": 860556029113578,\n \"model\": \"E3531\",\n \"sim\": {\n \"iccid\": 89314404000445576706,\n \"imsi\": 204046854521411\n },\n \"manufacturer\": \"huawei\",\n \"revision\": \"21.318.31.00.445\"\n },\n \"wlan_mac\": \"b827eb891e68\"\n },\n \"scan_enabled\": \"s\",\n \"sn\": \"SHU0L2V100N0362\"\n}"},{"id":"e1ba14bf-1806-485d-ac62-3d35f49b1c42","name":"Gateway doesn't exist","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":{"raw":"https://api.spaceti.net/v2/gateways/:serial_number","host":["https://api.spaceti.net/v2"],"path":["gateways",":serial_number"],"variable":[{"key":"serial_number","value":"SHU0L2V110N0362","description":"Gateway Serial Number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.8"},{"key":"Date","value":"Thu, 29 Apr 2021 12:45:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"X-Amzn-Requestid","value":"123ffb0d-3d16-417c-b75a-f12e6023a33f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Amz-Apigw-Id","value":"ei-NtGo2FiAFltA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-608aaa57-409d5bdd2ee0eda22ef61488;Sampled=0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 62b5081149b3b133b12c5d6cc0ac4b25.cloudfront.net (CloudFront), 1.1 vegur"},{"key":"X-Amz-Cf-Pop","value":"DUB2-C1"},{"key":"X-Amz-Cf-Id","value":"6XzLiIdLgmp8Y8YOK1rcsjuaPVhS-XbI2z3CPd71CeBt0__wn_khHQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Gateway does not exist.\"\n}"}],"_postman_id":"d85560da-cb20-42b7-8647-93217deb06d4"}],"id":"7a29d576-8186-4977-a1ab-54b7d944fda2","description":"Gateway is a special device that acts like a bridge. It collects all messages from the Spaceti sensors and sends them to the backend for further processing.
\nSome gateways are additionally sending their connectivity status that is stored as latest_service_info.
You are getting access only to the gateways associated with your account.
\n","_postman_id":"7a29d576-8186-4977-a1ab-54b7d944fda2"},{"name":"Device events","item":[{"name":"List events","id":"39a90d72-046b-4319-b81b-852e82e11b66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"https://api.spaceti.net/v2/events","description":"This endpoint returns you historical data from the devices. It also allows you to filter, sort and paginate data. On contrary to other endpoints, this one supports only forward pagination, previous attribute is not present at the response.
By default all events are sorted by timestamp of creation in descending order. It is also possible to sort in ascending order. For more information check parameter sort_by.
Currently supported filtration by several fields, such as Serial number, MAC address, device_type, building and floor. In case you are defining several filter parameters they are connected using logical conjunction. More information is available in Params section.
\nYou can also define time range that you are interested in using parameters timestamp_from, timestamp_to and time_zone. Events are stored with timestamp in UTC.
yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd), where the date must include the year at a minimum, and the time (separated by T), is optional. 2021-03-04T11:35:17 or 2021-03-04 are valid values.1614857714000 is valid.now-1m/d — the current time, minus one month, rounded down to the nearest dayOptional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Optional - Allows you to sort records. Value that can be passed to the API consists of + or - sign that defines sorting order and name of the attribute to sort by. By default set to -timestamp.
Optional - Filters records and returns only those associated with the device defined by Serial number.
\n","type":"text/plain"},"key":"sn","value":"Optional - Filters records and returns only those associated with the device defined by MAC address.
\n","type":"text/plain"},"key":"mac","value":"Optional - Filters records and returns only those associated with defined device_type.
\n","type":"text/plain"},"key":"device_type","value":"Optional - Filters records and returns only those associated with defined building.
\n","type":"text/plain"},"key":"building_id","value":"Optional - Filters records and returns only those associated with defined floor.
\n","type":"text/plain"},"key":"floor_id","value":"Optional - Filters records and returns only those that have timestamp greater or equal to specified value.\nFormat is described in the description of the endpoint itself.
\n","type":"text/plain"},"key":"timestamp_from","value":"Optional - Filters records and returns only those that have timestamp lower or equal to specified value.\nFormat is described in the description of the endpoint itself.
\n","type":"text/plain"},"key":"timestamp_to","value":"Optional - Coordinated Universal Time (UTC) offset or IANA time zone used to convert timestamp_from and timestamp_to values in the query to UTC.
Valid values are ISO 8601 UTC offsets, such as +01:00 or -08:00, and IANA time zone IDs, such as Europe/Prague.
This section gives you an access to the historical raw events coming from the devices associated with your account. You can find currently supported types of events and their API codes in the table below.
\nThis endpoint allows you to get the list of the bookings in your tenant. It also supports pagination.
\n","urlObject":{"path":["bookings"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Optional - Filters records and returns only those associated with defined space.
\n","type":"text/plain"},"key":"space_id","value":"Optional - Filters records and returns only those associated with defined user.
\n","type":"text/plain"},"key":"user_id","value":"Optional - Filters records and returns only those associated with defined user.
\n","type":"text/plain"},"key":"user_email","value":"Optional - Set to True if you want to search for the bookings where specified user (with either user_id or user_email) is present as either organizer or attendee. If set to False searches for the bookings where user is just an organizer. If not specified defaults to False.
\n","type":"text/plain"},"key":"search_attendees","value":"Optional - Set to True if you want to include bookings that were deleted in the response. If not specified defaults to False.
\n","type":"text/plain"},"key":"include_deleted","value":"Optional - Set to True if you want to include bookings that were rejected during approval phase in the response. If not specified defaults to False.
\n","type":"text/plain"},"key":"include_rejected","value":"Optional - Filters records and returns only those where start time is after the defined timestamp in request. Supports timestamps without timezone (e.g. 2024-11-25T15:00:00) or with timezone (e.g. 2024-11-25T15:00:00+01:00)
\n","type":"text/plain"},"key":"start_from","value":"Optional - Filters records and returns only those where start time is before the defined timestamp in request. Supports timestamps without timezone (e.g. 2024-11-25T15:00:00) or with timezone (e.g. 2024-11-25T15:00:00+01:00)
\n","type":"text/plain"},"key":"start_to","value":"Retrieve booking information using booking id.
Bookings are used to book workspace, meeting room or parking space.
\nAdditional information that you can find in the response is id and title of the booked space and information about the user who created the booking.
If the booking was deleted, field deleted_at would show timestamp of deletion, otherwise it will be null.
All the datetimes are in UTC+0.
\nDepending on the settings of your account, bookings might require check in by user.
\nField check_in_required tells you if check in is required for this booking or not. If it is required - check_in_completed shows if user has already performed it, and check_in_start_at and check_in_end_at define the checkin window.
Another feature that might be enabled for booking is booking approval. Approval status is located at the field approval.status and might be of values: bypassed - approval is not enabled, pending - approval is pending, approved - approval was successful, rejected - approval was declined.
Websockets are allowing you to use data from the devices connected to the Spaceti platform in real-time applications.
\nUsing websockets you open secured connection to the Spaceti server and receive stream of sensor data events or booking events. This approach is the preferred method versus polling the API every few seconds.
\nAuthorization is done in the same manner as for all other endpoints - using request header Authorization and Bearer YOUR_TOKEN as the value of this header.
There is a possibility to filter events by their location. Specify id of the location using query parameter. Currently following options are supported:
\nMaximum connection duration is 2 hours. After this period of time connection will be closed by server.
\nIdle connection timeout is set to 55 seconds. It means that connection will be closed by server if there was no data transfer in any direction during this time. Given that messages coming from the devices are not evenly distributed over time, it can happen that there will be no message for longer period than 55 seconds.
\nIn order to keep the stable connection, we strongly recommend to use ping messages going from the client to the server every 10 seconds. Server must respond with the pong message as described in the RFC6455. In this way the idle timeout would never happen and you can control the 2 hour duration limit and reconnect when server stops responding with pong messages.
\nwss://api.spaceti.net/v2/websocket/events
Websocket returns you device message in the JSON string. observer describes the device which submitted the message, event is the measurement itself and geo describes the location of the device in the tenant and building.
Types of the events and their respective units were described earlier in the Device events section.
Here you can see the example of returned data.
\n{\n \"observer\":{\n \"mac\":\"00124B00186B20E6\",\n \"sn\":\"SCP0L2P100N0000800\",\n \"device_type\":2\n },\n \"event\":{\n \"value\":0,\n \"type\":\"occupancy\",\n \"created_at\":1615888431\n },\n \"geo\":{\n \"overall_capacity\":1,\n \"building_id\":56,\n \"timezone\":\"Prague\",\n \"group_types\":[\n 1\n ],\n \"spaces\":[\n 423\n ],\n \"coordinates\":[\n 4.4565508056623,\n 26.9428468397733\n ],\n \"position\":[\n 14.439625475939728,\n 50.084438809269415\n ],\n \"groups\":[\n 137\n ],\n \"floor_id\":68,\n \"deployment_id\":316,\n \"space_types\":[\n 1\n ],\n \"tenant\":\"spacetihq\"\n }\n}\n\nwss://api.spaceti.net/v2/websocket/bookings
Websocket returns you booking event in the JSON string. Event consists of the booking id, type of the event that is always booking, action that can be create, update, destroy. The rest of the information about the booking is located in attributes object.
If the booking was deleted, field deleted_at would show timestamp of deletion, otherwise it will be null.
Here you can see the example of returned data.
\n{\n \"id\": 20284,\n \"type\": \"booking\",\n \"action\": \"create\",\n \"attributes\":\n {\n \"start_at\": \"2024-12-28 08:00:00\",\n \"end_at\": \"2024-12-28 16:00:00\",\n \"created_at\": \"2024-12-27 14:43:12\",\n \"updated_at\": \"2024-12-27 14:43:12\",\n \"deleted_at\": null,\n \"space\":\n {\n \"id\": 646\n },\n \"user\":\n {\n \"id\": 141\n },\n \"approval\":\n {\n \"status\": \"created\"\n },\n \"check_in\":\n {\n \"status\": \"inactive\",\n \"started_at\": null,\n \"expired_at\": null,\n \"completed_at\": null\n }\n }\n}\n\nThis endpoint allows you to get the list of the registered buildings in your tenant. It also supports pagination.
\n","urlObject":{"path":["buildings"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Retrieve the building information using building id.
Building object describes the basic information about the building registered in the Spaceti system.
\n","_postman_id":"689e6dc0-0d66-4454-9c44-734871e13257"},{"name":"Floors","item":[{"name":"List floors","id":"56537a9d-265b-44a3-91ad-bc0afd056198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"https://api.spaceti.net/v2/floors","description":"This endpoint allows you to get the list of the registered floors in your tenant. It also supports pagination.
\n","urlObject":{"path":["floors"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Retrieve floor information using floor id.
Floor object describes the basic information about the floor registered in the building in the Spaceti system.
\n","_postman_id":"7170d82b-b4a8-400f-9de6-0b6a499c6ab0"},{"name":"Groups","item":[{"name":"List groups","id":"4fca2fc2-cbf5-4987-874d-da7a030cf330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"https://api.spaceti.net/v2/groups","description":"This endpoint allows you to get the list of the groups in your tenant. It also supports pagination.
\n","urlObject":{"path":["groups"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Retrieve group information using group id.
Group aggregate several spaces to perform analysis of occupancy and environment. For example, all the working stations of some department can be grouped and compared with other departments on the utilisation and occupancy.
\n","_postman_id":"c522dd1a-addd-4d7f-a155-35877381ee98"},{"name":"Spaces","item":[{"name":"List spaces","id":"4b9872f1-c3e8-472c-adbe-fd518765408a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"https://api.spaceti.net/v2/spaces","description":"This endpoint allows you to get the list of the registered spaces in your tenant. It also supports pagination.
\n","urlObject":{"path":["spaces"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Retrieve space information using space id.
Space object describes the basic information about the space registered in the building in the Spaceti system. Meeting rooms, common spaces, workstations, parking spots are defined as spaces. You can distinguish the use case of the particular space using space_type attribute.
This endpoint allows you to get the list of the registered deployments in your tenant. It also supports pagination.
\n","urlObject":{"path":["deployments"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"Retrieve deployment information using deployment id.
The deployment object represents an installation of a device within a specific floor of your building. Any device can only have one active deployment.
\nDeployments are connected to spaces as many-to-many relation to aggregate data on the space level from multiple devices and display it in analytics. Deployment attribute connected_to_spaces gives you a list of space ids to which this deployment/device is connected.
This endpoint enables real-time AI-driven interactions related to analytics. Integrate it into your product to allow users to query and receive actionable insights using natural language.
\nCommunication method is Socket.io (bi-directional real-time communication).
\nDetailed documentation on authorization and data payload structure is available upon request.
\n","urlObject":{"path":["ai","converse","analytics"],"host":["https://api.spaceti.net/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5d6d3db-8a25-4fd9-b0f9-09e8f03d6d22"},{"name":"Bookings AI Conversation","id":"8fb58e25-d09d-49ca-9089-88151b676cf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spaceti.net/v2/ai/converse/bookings","description":"This endpoint allows users to interact with Spaceti’s booking system via chat, enabling actions like checking availability or making reservations using conversational input.
\nCommunication method is Socket.io (bi-directional real-time communication).
\nDetailed documentation on authorization and data payload structure is available upon request.
\n","urlObject":{"path":["ai","converse","bookings"],"host":["https://api.spaceti.net/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fb58e25-d09d-49ca-9089-88151b676cf2"},{"name":"List chats","id":"73b2b54e-aba6-4567-a465-f407bd37ba74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer JWT_TOKEN","type":"text"},{"key":"Account","value":"TENANT_ID","type":"text"}],"url":"https://api.spaceti.net/v2/ai/chats","description":"This endpoint returns list of user's historical chats with AI.
\n","urlObject":{"path":["ai","chats"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Id of the building where chat was created
\n","type":"text/plain"},"key":"building_id","value":"Optional - Specify analytics_ai or bookings_ai to get chats with specific context
Optional - Returns only chats with specified query text in messages.
\n","type":"text/plain"},"key":"query","value":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"This endpoint returns list of messages withing a historical chat.
\n","urlObject":{"path":["ai","chats","{chat_id}","messages"],"host":["https://api.spaceti.net/v2"],"query":[{"disabled":true,"description":{"content":"Optional - Limits the number of returned records. Maximum is 500, default - 100.
\n","type":"text/plain"},"key":"page_size","value":"This section provides an overview of the available API endpoints for integrating with Spaceti AI, enabling powerful AI chat functionality within your application. These endpoints support real-time communication via Socket.io, as well as RESTful endpoints for managing historical chat data.
\n","_postman_id":"f0ffbce6-4d94-4b37-9087-871d3e1ce912"}],"event":[{"listen":"prerequest","script":{"id":"508dc725-afce-4a1c-a1d1-80b5e93ca6ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"259efb5d-eaf9-4869-af05-732796b241a5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"https://api.spaceti.net/v2"},{"key":"token","value":"YOUR_TOKEN"},{"key":"jwt_token","value":"JWT_TOKEN","type":"string"},{"key":"account","value":"TENANT_ID","type":"string"}]}