The Sleepacta API Layer is the HTTP interface exposed by the Sleepacta platform frontend. It covers the full lifecycle of a sleep study, from account and device management through to exam execution, result retrieval, and patient communication.
\nAll authenticated endpoints require an Authorization header in the format APIauth: <token>, obtained via the Authentication endpoints.
Handles all authentication flows: standard username/password login, cookie-based login, login by external identifier, OTP validation, token refresh, partner assignment, and logout.
\nCovers the full lifecycle of a sleep exam: selecting an available device, creating a delivery, uploading raw data, generating the exam, retrieving results, and marking an exam as unreliable.
\nManages partner accounts: creating a new account, retrieving the list of existing accounts, and updating account details including device assignment, exam caps, and account status.
\nHandles all password-related operations: initiating a forgot-password flow, resetting a password via a temporary code, and changing a known password.
\nEndpoints for updating patient metadata associated with exams: updating the patient nickname and the patient external identifier.
\nManages questionnaires and their responses. Supports two questionnaire types: one-shot questionnaires (linked to a shipment, delivery, exam, or device) and recurring questionnaires (linked to a session with multiple rounds). Includes endpoints for listing and retrieving questionnaire structures, managing recurring sessions, submitting answers step by step, and reading previously submitted answers.
\nEndpoints for recording and retrieving Sleepacta Signal GUI-level execution logs.
\nEndpoint for retrieving pending private notifications for the authenticated user.
\nEndpoints for retrieving and accepting the Terms & Conditions within the DORMI platform.
\nEndpoint for creating shipment requests on behalf of a partner, including end-user personal and physical details.
\nUtility endpoints: API version (public), authenticated user profile and context, and partner logo retrieval.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21077355","collectionId":"58495582-5172-4e19-8e5f-29222799580a","publishedId":"2sB2cYd1Lv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-09-13T08:16:53.000Z"},"item":[{"name":"Authentication","item":[{"name":"login","id":"d6d239c7-0c9a-41c5-99f4-592ba1b40d65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{USERNAME}}\",\r\n \"password\": \"{{PASSWORD}}\",\r\n \"partner_id\": \"{{PARTNER_ID}}\",\r\n \"server_2_server\": \"{{SERVER_TO_SERVER}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/login","description":"Authenticates a user with email and password and returns an access token
\nAuthenticates a user using an external identifier and returns an access token
\nAuthenticates a user via a session cookie and returns an access token
\n","urlObject":{"path":["api","login_by_cookie"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"4acaaef3-6c23-45ba-8e5a-169f6ae39b38","name":"login_by_cookie_response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{USERNAME}}\",\r\n \"password\": \"{{PASSWORD}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.sleepacta.com/api/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 14 May 2025 16:46:04 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"869"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server-Timing","value":"rt;dur=0.631;desc=Process-Time"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Xp%2BZdLXQoGzZ2vR%2F2nXGJfAktZK%2BXP2KOFnhJ%2FwGzjbx27jCgSAZYVEAGBoV7Cd8cnUIALLMEAE9oGDt%2F0TH4%2Bx%2B%2FdbAcNZlrQ0yz%2BII8AX2UQUd1sTgTsM6Xrypal3ikZud9XiwkbrutEA1WItFdog%3D\"}]}"},{"key":"CF-RAY","value":"93fbde980a56c587-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"auth_data\": {\n \"token\": \"the-auth-token\",\n \"expiration\": \"2026-06-14 16:56:04\",\n \"curr_partner_id\": \"1\",\n \"curr_account_name\": \"Demo User\",\n \"curr_account_id\": \"14\",\n \"curr_account_skip_otp\": \"0\",\n \"curr_account_otp_expiration\": \"2026-09-04 00:12:41\",\n \"curr_account_password_expiration\": \"2027-04-08 14:36:12\",\n \"curr_account_external_identifier\": \"my-external-id\",\n \"curr_account_role\": \"1\",\n \"curr_account_is_end_user\": \"0\",\n \"curr_account_age\": null,\n \"curr_account_weight\": null,\n \"curr_account_height\": null,\n \"curr_account_gender\": null,\n \"curr_account_can_create_exams\": \"1\",\n \"curr_account_can_use_only_own_devices\": \"0\",\n \"curr_account_has_advanced_gui_options\": \"0\",\n \"curr_account_has_beta_firmware_access\": \"1\",\n \"curr_partner_name\": \"Demo Partner\",\n \"curr_partner_timezone\": \"Europe/Rome\",\n \"curr_partner_dormi_apnea_mode\": \"standard\",\n \"curr_partner_additional_analysis\": \"activity-level-classification,altertness, ...\",\n \"curr_partner_device_configurations\": [\n {\n \"device_configuration_id\": \"1\",\n \"name\": \"Sleep - 10g\",\n \"configuration_url\": \"https://config.openmovement.dev/#nodetails&rate=12.5&range=8&gyro=0&stop=240&minbattery=80&title=Sleepacta%20-%20AX%20Configure&config=0\",\n \"annotations\": \"12.5Hz, 10g\",\n \"producer_id\": \"2\",\n \"producer_name\": \"Axivity\",\n \"supported_exam_type\": \"sleep+apnea\",\n \"supported_additional_analysis\": null,\n \"supported_dormi_apnea_mode\": \"lite\"\n },\n {\n \"device_configuration_id\": \"7\",\n \"name\": \"Signal Configuration\",\n \"configuration_url\": \"https://signal.sleepacta.com/\",\n \"annotations\": \"\",\n \"producer_id\": \"4\",\n \"producer_name\": \"Sleepacta\",\n \"supported_exam_type\": \"sleep+apnea\",\n \"supported_additional_analysis\": \"activity-level-classification,altertness, ... \",\n \"supported_dormi_apnea_mode\": \"standard\"\n }\n ],\n \"linked_partners\": [\n {\n \"partner_id\": \"1\",\n \"partner_name\": \"Demo Partner\"\n },\n {\n \"partner_id\": \"2\",\n \"partner_name\": \"Demo Partner 2\"\n }\n ],\n \"server_2_server\": true,\n \"terms_and_conditions\": {\n \"approval_date\": \"2026-06-10 07:42:49\",\n \"version\": \"v01.00\",\n \"current_version\": \"v01.00\"\n }\n }\n}"}],"_postman_id":"9e77104c-fb0b-4a75-b7dd-a37a9039eae8"},{"name":"refresh_token","id":"6c94a8f0-f51f-4b7a-84ba-f9825431c0e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{AUTH_TOKEN}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/refresh_token","description":"Refreshes the current access token and returns a new valid token
\nValidates a one-time password for two-factor authentication
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"partner_id\": \"{{PARTNER_ID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/set_partner_id","description":"Associates the authenticated user session with a specific partner ID
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/logout","description":"Terminates the current user session and invalidates the access token
\n","urlObject":{"path":["api","logout"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"00e2f0b0-a5a4-400b-a2ce-da1e2f4bd2d0","name":"logout_response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"APIauth: your-auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{AUTH_TOKEN}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.sleepacta.com/api/refresh_token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 13 Apr 2025 08:29:29 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"194"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PHP/8.1.31"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=0.091;desc=Process-Time"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=5976&min_rtt=1942&rtt_var=8181&sent=11&recv=12&lost=0&retrans=0&sent_bytes=4105&recv_bytes=2933&delivery_rate=1450901&cwnd=4&unsent_bytes=0&cid=19254204a3cf32ad&ts=58601&x=0\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=dAPoLlntiTOfTqpWvP4Fw%2Ft%2F6UVM3%2FHOWDUZ1AI1gnkIgDqetdDGgh9qILDtGOPz9AEQ5Y5Pbmgli1sfkIi5gbAcLEdAUuY5cFjiWCW4mOnb5UUbrH0y95c0fSFWvHCCcbfKrT9GCPOaW%2B8fMK0xsT0%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92f998931c9357ea-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"auth_data\": {\n \"token\": \"your-new-auth-token\",\n \"expiration\": \"2025-04-13 08:22:14\",\n \"allowed_partners\": [\n \"3\"\n ],\n \"curr_account_id\": null\n }\n}"}],"_postman_id":"62e7efb7-b3af-43f7-a8a3-842fa29d3cd7"}],"id":"b0d25a96-b8ad-4582-8855-c4f055291d02","description":"The API platform supports multiple authentication mechanisms designed to accommodate server-to-server integrations, web applications, and third-party systems.
\nThe standard authentication flow begins with the login endpoint, which returns an authentication token. This token must be included in the Authorization header of all subsequent API requests that require authentication. Detailed information about the authentication header format and response payload is available in the documentation of the individual endpoints.
Authentication tokens have a limited lifetime and can be renewed through the refresh_token endpoint without requiring the user to authenticate again. When the session is no longer needed, the logout endpoint can be used to invalidate the current authentication context.
In environments where a user may have access to multiple partners (tenants), the set_partner_id endpoint allows the client to select the active partner context for subsequent operations.
In addition to standard username/password authentication, the platform provides alternative login methods. The login_by_external_identifier endpoint allows authentication using an external identifier associated with the user account, making it suitable for integrations with third-party identity systems. The login_by_cookie endpoint supports Single Sign-On (SSO) scenarios, enabling authentication based on a cookie previously issued by an external application and recognized by the platform backend.
For non-server-to-server authentication flows, additional security can be enforced through One-Time Password (OTP) verification. In such cases, an OTP code is sent to the user's email address and must be validated through the validate_otp endpoint before authentication is considered complete.
Refer to the documentation of the individual endpoints for detailed request and response specifications, parameter descriptions, and authentication requirements.
\n","_postman_id":"b0d25a96-b8ad-4582-8855-c4f055291d02"},{"name":"Exams Workflow","item":[{"name":"get_available_devices","id":"0d6eaed9-ea77-4d98-bc35-e6a7b551201d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_available_devices","description":"Retrieves the list of devices available for assignment to a new delivery
\n","urlObject":{"path":["api","get_available_devices"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"543ff753-8b41-4898-bf1b-27ad85162a91","name":"get_available_devices_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: your-auth-token","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://partners-testing.sleepacta.com/api/get_available_devices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Apr 2025 11:26:47 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"473"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PHP/8.1.31"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=0.097;desc=Process-Time"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2347&min_rtt=2141&rtt_var=950&sent=3&recv=5&lost=0&retrans=0&sent_bytes=219&recv_bytes=1153&delivery_rate=676319&cwnd=212&unsent_bytes=0&cid=5f38d431a0e8429a&ts=424&x=0\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=2jlvZ5sKqI%2FZY9O9hZSReuVYxxpCfodAIYLUSgoAZhnBkbZEHzCPlcEn%2BGqsviSeTG%2BrIJvLynHgDG2RDTVcpHDrkNPXf6CQOYIjqvYWxbc5iUtvoVGUWZTZ78UkJdIc%2BxWFTZ%2Fd43qkWpjZm82zeRM%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92f25ee8192e205a-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"devices\": [\n {\n \"id\": \"81\",\n \"partner_id\": \"1\",\n \"patient_id\": \"0\",\n \"producer_id\": \"3\",\n \"vendor_code\": \"26-000100\",\n \"model\": \"Signal\",\n \"location\": \"Sleepacta Warehouse\",\n \"owner\": \"Sleepacta\",\n \"account_name_filter\": \"\",\n \"status\": \"authorized\",\n \"creation_date\": \"2024-07-24 16:42:36\",\n \"last_sync_date\": \"2024-10-15 12:36:37\",\n \"visible\": \"1\",\n \"annotations\": \"\",\n \"producer_invoice_id\": \"24\",\n \"producer_dispatch_date\": \"2024-11-26 00:00:00\",\n \"producer_name\": \"Sleepacta\"\n },\n {\n \"id\": \"88\",\n \"partner_id\": \"1\",\n \"patient_id\": \"0\",\n \"producer_id\": \"2\",\n \"vendor_code\": \"606114\",\n \"model\": \"AX6\",\n \"location\": \"Rome - Customer Office\",\n \"owner\": \"Sleepacta\",\n \"account_name_filter\": \"\",\n \"status\": \"authorized\",\n \"creation_date\": \"2024-12-10 18:08:53\",\n \"last_sync_date\": \"2025-03-18 11:19:04\",\n \"visible\": \"1\",\n \"annotations\": \"\",\n \"producer_invoice_id\": null,\n \"producer_dispatch_date\": null,\n \"producer_name\": \"Axivity\"\n }\n ]\n}"}],"_postman_id":"0d6eaed9-ea77-4d98-bc35-e6a7b551201d"},{"name":"insert_delivery","id":"d174d6ba-e91c-4b4e-9d58-01fa10d8b740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"device_id\": \"{{DEVICE_ID}}\",\r\n \"patient_identifier\": \"test\",\r\n \"patient_age\": \"50\",\r\n \"patient_gender\": \"M\",\r\n \"patient_height\": \"185\",\r\n \"patient_weight\": \"80\",\r\n \"exam_type\": \"sleep\",\r\n \"device_configuration_id\": 1,\r\n \"firmware_version\": \"1.24.22\",\r\n \"delivery_date\": \"2025-11-25 13:00:00\",\r\n \"end_recording_date\": \"2025-11-30 13:00:00\",\r\n\r\n \"plot_steps\": \"1\",\r\n \"plot_temperature\": \"1\",\r\n \"plot_heartrate\": \"1\",\r\n \"plot_breathrate\": \"0\",\r\n \"plot_light\": \"1\",\r\n \"plot_double_taps\": \"0\",\r\n \"plot_hr_single_beats\": \"0\",\r\n \"plot_hrv_rmssd_bcg\": \"0\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/insert_delivery","description":"Creates a new delivery record and assigns a device to a patient
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_open_deliveries","description":"Retrieves all deliveries that are currently open and pending data upload
\n","urlObject":{"path":["api","get_open_deliveries"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"264909df-fe75-45ae-9637-4ca0ddde1bb3","name":"get_open_deliveries_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_open_deliveries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 14 May 2025 12:32:09 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"1091"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server-Timing","value":"rt;dur=0.110;desc=Process-Time"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=z3qggy57To8%2FRFoWYQb9B%2B7yxSFkS%2B5Dck2v2yyyTnOdh7DEOXZCAPq1vzDibZlNoDwt983qHG5%2Bpgh%2FvBWbTyNgjF49AnnlTdBsZu0W02UssLtj%2FbT2Lxhx8R5G6%2B1bSntVQ55YKEphlGTtvkInmXc%3D\"}]}"},{"key":"CF-RAY","value":"93fa6aa73d2956b6-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"deliveries\": [\n {\n \"id\": \"51\",\n \"creation_date\": \"2024-09-24 16:07:25\",\n \"delivery_date\": \"2024-09-24 16:07:00\",\n \"last_mod_date\": \"2024-09-24 16:07:25\",\n \"device_configuration_id\": null,\n \"shipment_id\": \"82\",\n \"device_id\": \"83\",\n \"patient_id\": null,\n \"patient_identifier\": \"A1\",\n \"patient_age\": \"33\",\n \"patient_weight\": \"0\",\n \"patient_height\": \"0\",\n \"patient_gender\": \"M\",\n \"patient_external_identifier\": \"my-external-id-1\",\n \"partner_id\": \"1\",\n \"account_id\": \"3\",\n \"last_mod_account_id\": \"3\",\n \"completed\": \"0\",\n \"virtual\": \"0\",\n \"annotations\": \"\",\n \"exam_type\": \"sleep\",\n \"device_annotations\": \"\",\n \"vendor_code\": \"26-000100\",\n \"device_model\": \"Signal\",\n \"device_owner\": \"Sleepacta\",\n \"account_name_filter\": \"my-filter\",\n \"device_location\": \"\",\n \"device_visible\": \"1\",\n \"device_status\": \"authorized\",\n \"device_last_sync_date\": \"2025-04-14 20:06:33\",\n \"producer_id\": \"3\",\n \"partner_name\": \"Demo Partner\",\n \"account_name\": \"My Name\",\n \"last_mod_account_name\": \"My Name\",\n \"producer\": \"Sleepacta\",\n \"manual_upload\": \"1\",\n \"web_configuration\": \"1\",\n \"last_sync_api\": \"1\"\n },\n {\n \"id\": \"53\",\n \"creation_date\": \"2024-10-22 15:04:54\",\n \"delivery_date\": \"2024-10-22 15:04:00\",\n \"last_mod_date\": \"2024-10-22 15:04:54\",\n \"device_configuration_id\": null,\n \"shipment_id\": \"0\",\n \"device_id\": \"76\",\n \"patient_id\": null,\n \"patient_identifier\": \"A2\",\n \"patient_age\": \"33\",\n \"patient_weight\": \"0\",\n \"patient_height\": \"0\",\n \"patient_gender\": \"M\",\n \"patient_external_identifier\": \"my-external-id-2\",\n \"partner_id\": \"1\",\n \"account_id\": \"3\",\n \"last_mod_account_id\": \"3\",\n \"completed\": \"0\",\n \"virtual\": \"0\",\n \"annotations\": \"\",\n \"exam_type\": \"sleep\",\n \"device_annotations\": \"\",\n \"vendor_code\": \"12345678\",\n \"device_model\": \"AX6\",\n \"device_owner\": \"Sleepacta\",\n \"account_name_filter\": null,\n \"device_location\": \"My Office\",\n \"device_visible\": \"0\",\n \"device_last_sync_date\": \"2023-09-19 17:40:55\",\n \"producer_id\": \"1\",\n \"partner_name\": \"Demo Partner\",\n \"account_name\": \"My Name\",\n \"last_mod_account_name\": \"My Name\",\n \"producer\": \"Axivity\",\n \"manual_upload\": \"1\",\n \"web_configuration\": \"1\",\n \"last_sync_api\": \"0\"\n }\n ]\n}"}],"_postman_id":"2cf75a9e-0de4-4f68-abf8-2f17ebfda0da"},{"name":"upload_raw_data","id":"ba57b298-4771-4283-99e7-bcaef1970ac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"formdata","formdata":[{"key":"raw_data","value":"{{RAW_DATA_ZIP_FILE}}","description":"a ZIP file containing the device raw data
\n","type":"text"},{"key":"device_id","value":"{{DEVICE_ID}}","description":"the unique identifier of the device that recorded the data
\n","type":"text"},{"key":"delivery_id","value":"{{DELIVERY_ID}}","description":"the delivery identifier; can be used instead of device_id
\n","type":"text"}]},"url":"{{FRONTEND_BASE_URL}}/api/upload_raw_data","description":"Uploads raw sensor data from a device for a specific delivery
\n","urlObject":{"path":["api","upload_raw_data"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"77f66b8c-805b-4a96-9b6a-16feaa563e84","name":"upload_raw_data_response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"APIauth: your-auth-token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"raw_data","description":"the ZIP file to be uploaded","type":"file","uuid":"38fd2e56-d272-4259-a093-5d60c044f7b8","src":"h5b0UUso0/test.zip"},{"key":"device_id","value":"84","description":"(optional) the device identifier","type":"text","uuid":"5e06e9c7-b540-490f-8277-71afc3d1c7df"},{"key":"delivery_id","value":"70","description":"(optional) the delivery identifier","type":"text","uuid":"d7ef7526-240d-41be-b21f-42d9a36f4705","disabled":true}]},"url":"https://partners-testing.sleepacta.com/api/upload_raw_data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Apr 2025 23:42:55 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"129"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PHP/8.1.31"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=2.353;desc=Process-Time"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2302&min_rtt=2169&rtt_var=909&sent=38&recv=139&lost=0&retrans=0&sent_bytes=219&recv_bytes=181869&delivery_rate=667588&cwnd=230&unsent_bytes=0&cid=ece74a6f2ef8d3a2&ts=2901&x=0\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=s9FWMEqr0uX6wPcz3D4eQRiCAmutIK8WoX2Q5nYiIZ84w0l%2Bm58VZb3jonUiD1VMf9xE1vYQ0ExN2GMZLCtqyjneuO2yGxAXAqpySPR4xJ3nMLY6pARUChy1cOeDY5vevpp%2BPNHxwevpxjoWkwGv2Kc%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92f69529cd6af278-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"update_info\": {\n \"updated_device_id\": \"84\",\n \"update_date\": \"2025-04-12T23:42:55.235Z\"\n }\n}"}],"_postman_id":"ba57b298-4771-4283-99e7-bcaef1970ac2"},{"name":"create_exam_from_delivery","id":"45312ffd-4725-4aa1-8028-62a45b483a1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"delivery_id\": \"{{DELIVERY_ID}}\",\r\n \"override_start_date\": \"{{OVERRIDE_START_DATE}}\",\r\n \"override_end_date\": \"{{OVERRIDE_END_DATE}}\",\r\n \"lang\": \"it\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/create_exam_from_delivery","description":"Creates a new exam record by processing the data from a completed delivery
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_exam?id={{EXAM_ID}}&full_version={{FULL_VERSION}}&lang={{LANGUAGE}}","description":"Retrieves the details of a specific exam by its ID
\n","urlObject":{"path":["api","get_exam"],"host":["{{FRONTEND_BASE_URL}}"],"query":[{"description":{"content":"the unique identifier of the exam to retrieve
\n","type":"text/plain"},"key":"id","value":"{{EXAM_ID}}"},{"description":{"content":"set to 1 to return the full exam data including all metrics (default 0)
\n","type":"text/plain"},"key":"full_version","value":"{{FULL_VERSION}}"},{"description":{"content":"exam language (e.g. \"it\", \"en\", etc.)
\n","type":"text/plain"},"key":"lang","value":"{{LANGUAGE}}"}],"variable":[]}},"response":[{"id":"adc103ea-a123-4ed1-9295-529b8f3124b5","name":"get_exam_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: your-auth-token","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://partners.sleepacta.com/api/get_exam?id=342","protocol":"https","host":["partners","sleepacta","com"],"path":["api","get_exam"],"query":[{"key":"id","value":"342","description":"the exam identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 13 Apr 2025 08:45:34 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"2705"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"PHP/8.1.31"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=2.360;desc=Process-Time"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=2076&min_rtt=1944&rtt_var=823&sent=3&recv=5&lost=0&retrans=0&sent_bytes=219&recv_bytes=1147&delivery_rate=744855&cwnd=230&unsent_bytes=0&cid=7d72eb248d4e7ee9&ts=2694&x=0\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=jY4zqf84fGsq8Wt6WDuqcab3nJ3GNsdFf7eg0i8o7xxoMjAGEEtqvnfUckKXaZlNRn%2Bgr13UH0ZKQZ%2Fd%2F%2BtVUTX8RqYCdQTP1o%2FQ5eMyvK9YDkwEkN%2F8wPKXfNZdiT6ofiP9WUm5it6Fto6NV5kSqr0%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"92f9b01309e972ec-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"exam\": {\n \"exam_id\": \"342\",\n \"partner_name\": \"Demo Partner\",\n \"exam_type\": \"sleep+apnea\",\n \"creation_date\": \"2025-04-12 11:48:56\",\n \"creator\": {\n \"name\": \"John Smith\",\n \"id\": 34\n },\n \"start_date\": \"2025-04-12 11:48:41\",\n \"end_date\": \"2025-04-12 11:48:56\",\n \"status\": \"completed\",\n \"doctor_name\": null,\n \"reporting_date\": null,\n \"annotations\": \"\",\n \"timezone\": \"Europe/Rome\",\n \"language\": \"it\",\n \"last_run_id\": \"1302\",\n \"algorithm\": \"Dormi (FP.v01)\",\n \"device\": {\n \"producer\": \"Axivity\",\n \"vendor_code\": \"0000111\"\n },\n \"patient\": {\n \"age\": 50,\n \"nickname\": \"patient-anonymous-id\",\n \"gender\": \"M\",\n \"weight\": 80,\n \"height\": 185,\n \"external_identifier\": \"my-external-id\"\n },\n \"delivery\": {\n \"delivery_id\": \"118\",\n \"account_name\": \"John Smith\",\n \"creation_date\": \"2025-04-12 11:48:41\",\n \"delivery_date\": \"2025-04-12 11:48:41\",\n \"annotations\": \"\"\n },\n \"avg_kpis\": {\n \"tst\": \"313.888889\",\n \"se\": \"83.993334\",\n \"waso\": \"78.111111\",\n \"sri\": \"80.779999\",\n \"naw\": \"38.4444\",\n \"daw\": \"5.378889\",\n \"mi\": \"5.013333\",\n \"ai\": \"25.277778\",\n \"sleep_onset\": \"23:08\",\n \"sleep_offset\": \"07:06\"\n },\n \"daily_logs\": [\n {\n \"day_idx\": \"0\",\n \"start_date\": \"2024-09-02 00:00:00\",\n \"end_date\": \"2024-09-02 00:00:00\",\n \"sleep_onset\": \"01:23:00\",\n \"sleep_offset\": \"07:20:00\",\n \"tst\": \"299.00\",\n \"se\": \"83.75\",\n \"sri\": \"80.78\",\n \"naw\": \"57\",\n \"daw\": \"3.59\",\n \"mi\": \"5.18\",\n \"ai\": \"18.50\"\n },\n {\n \"day_idx\": \"1\",\n \"start_date\": \"2024-09-03 00:00:00\",\n \"end_date\": \"2024-09-03 00:00:00\",\n \"sleep_onset\": \"00:15:00\",\n \"sleep_offset\": \"06:52:00\",\n \"tst\": \"360.00\",\n \"se\": \"90.68\",\n \"sri\": \"80.78\",\n \"naw\": \"38\",\n \"daw\": \"2.68\",\n \"mi\": \"3.90\",\n \"ai\": \"15.50\"\n }\n ],\n \"plots\": [\n \"https://aws-path/plot1.png\",\n \"https://aws-path/plot2.png\",\n \"https://aws-path/plot_gauge_se_sri.png\"\n ],\n \"normative_kpis_cat\": {\n \"tst\": 0,\n \"waso\": 1,\n \"se\": 1,\n \"sri\": 0,\n \"daw\": 1,\n \"naw\": 1,\n \"mi\": 0,\n \"ai\": 1\n },\n \"daily_osas\": {\n \"2024-09-01 01:23\": 0,\n \"2024-09-02 00:15\": 1\n },\n \"daily_steps\": {\n \"2024-09-01\": \"4675\",\n \"2024-09-02\": \"3817 *\"\n },\n \"unreliable_exam\": false,\n \"reporting_suggestions\": \"The self-generated reporting notes suggestions...\",\n \"questionnaires\": [\n {\n \"survey_id\": \"1\",\n \"title\": \"Questionnaire A\",\n \"total_score\": 12,\n \"answers\": [\n {\n \"question_id\": \"101\",\n \"topic\": \"Topic 1\",\n \"question\": \"Sample question 1?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"501\",\n \"answer\": \"Sample answer 1\"\n }\n ]\n },\n {\n \"question_id\": \"102\",\n \"topic\": \"Topic 1\",\n \"question\": \"Sample question 2?\",\n \"type\": \"multi\",\n \"answers\": [\n {\n \"answer_id\": \"510\",\n \"answer\": \"Sample answer A\"\n },\n {\n \"answer_id\": \"511\",\n \"answer\": \"Sample answer B\"\n }\n ]\n },\n {\n \"question_id\": \"103\",\n \"topic\": \"Topic 2\",\n \"question\": \"Sample open question?\",\n \"type\": \"free\",\n \"answers\": [\n {\n \"answer_id\": null,\n \"answer\": \"Free-text answer provided by the user\"\n }\n ]\n }\n ],\n \"profiles\": [\n {\n \"title\": \"Profile Label 1\",\n \"description\": \"Generic profile description text.\",\n \"prog\": 1\n }\n ],\n \"indications\": [\n {\n \"title\": \"Indication Label 1\",\n \"description\": \"Generic indication description text.\",\n \"prog\": 1\n }\n ]\n }\n ],\n \"pvt_tests\": [\n {\n \"protocol\": \"pvt3\",\n \"started_at_iso\": \"2026-06-15T10:22:41.031Z\",\n \"duration_ms\": 180000,\n \"n_trials\": 46,\n \"n_valid\": 46,\n \"n_false_starts\": 0,\n \"n_no_response\": 0,\n \"mean_rt_ms\": 274.7608695650959,\n \"median_rt_ms\": 258.19999999925494,\n \"slowest10_mean_ms\": 442.0599999997765,\n \"speed_per_s\": 3.8290840960342605,\n \"lapses\": 1\n }\n ],\n \"public_url\": \"https://the-exam-public-link\"\n }\n}"}],"_postman_id":"da9aacba-edf1-4e5d-8db3-784641e4e58f"},{"name":"get_exams","id":"52b76ca9-3380-4cab-a702-a5b9d878fa78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_exams","description":"Retrieves the list of all exams accessible to the authenticated user
\n","urlObject":{"path":["api","get_exams"],"host":["{{FRONTEND_BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"the number of exams to return (default 10)
\n","type":"text/plain"},"key":"num_records","value":"{{NUM_RECORDS}}"},{"disabled":true,"description":{"content":"the offset of the first record to return (default 1)
\n","type":"text/plain"},"key":"start","value":"{{START}}"},{"disabled":true,"description":{"content":"the field to sort results by (id, creation_date, status)
\n","type":"text/plain"},"key":"order_by","value":"{{ORDER_BY}}"},{"disabled":true,"description":{"content":"the sort direction (asc or desc)
\n","type":"text/plain"},"key":"asc_desc","value":"{{ASC_DESC}}"},{"disabled":true,"description":{"content":"filter exams with monitoring start date on or after this date (yyyy-mm-dd)
\n","type":"text/plain"},"key":"start_date","value":"{{START_DATE}}"},{"disabled":true,"description":{"content":"filter exams with monitoring end date on or before this date (yyyy-mm-dd)
\n","type":"text/plain"},"key":"end_date","value":"{{END_DATE}}"},{"disabled":true,"description":{"content":"filter by patient info such as anonymous identifier
\n","type":"text/plain"},"key":"patient","value":"{{PATIENT}}"},{"disabled":true,"description":{"content":"filter by exam status (completed or error)
\n","type":"text/plain"},"key":"status","value":"{{STATUS}}"},{"disabled":true,"description":{"content":"filter by the unique identifier of the account that created the exam
\n","type":"text/plain"},"key":"account_id","value":"{{ACCOUNT_ID}}"},{"disabled":true,"description":{"content":"filter exams that ended after this date (yyyy-mm-dd)
\n","type":"text/plain"},"key":"ended_after","value":"{{ENDED_AFTER}}"},{"disabled":true,"description":{"content":"return only exams with an ID greater than or equal to this value
\n","type":"text/plain"},"key":"min_exam_id","value":"{{MIN_EXAM_ID}}"},{"disabled":true,"description":{"content":"filter by the external identifier of the patient's account
\n","type":"text/plain"},"key":"patient_external_identifier","value":"{{PATIENT_EXTERNAL_IDENTIFIER}}"}],"variable":[]}},"response":[{"id":"ffc6e6f7-26df-4fe8-812a-e4c8b419d34a","name":"get_exams_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_exams?num_records=2","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_exams"],"query":[{"key":"num_records","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sat, 13 Sep 2025 07:56:08 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"327"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"x-powered-by","value":"PHP/8.1.31"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=0.109;desc=Process-Time"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=TbMXtcRszI0XD1guiRcZJUnC7Rml3R9W7cQ7mSKHePEQxQVTL%2Bq%2B2TvwrERE8xeUxSTa1fri3xelHScq218xnB%2BeZqSKyNSGYYiavdQBZqn85EPhY7eFw9L16AW6mg%3D%3D\"}]}"},{"key":"CF-RAY","value":"97e61614d852aa2d-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"exams\": [\n {\n \"exam_id\": \"451\",\n \"partner_name\": \"Demo Partner\",\n \"exam_type\": \"sleep+apnea\",\n \"creation_date\": \"2025-09-11 12:02:22\",\n \"creator\": {\n \"name\": \"John Smith\",\n \"id\": 34\n },\n \"device\": {\n \"producer\": \"Sleepacta\",\n \"vendor_code\": \"25-00018\"\n },\n \"delivery\": {\n \"delivery_id\": \"118\",\n \"account_name\": \"John Smith\",\n \"creation_date\": \"2025-09-01 12:01:00\",\n \"delivery_date\": \"2025-09-01 12:01:00\",\n \"annotations\": \"\"\n },\n \"patient\": {\n \"age\": 34,\n \"nickname\": \"TB\",\n \"gender\": \"M\",\n \"weight\": 60,\n \"height\": 175,\n \"external_identifier\": \"my-external-id\"\n },\n \"start_date\": \"2025-09-01 12:01:00\",\n \"end_date\": \"2025-09-11 11:51:00\",\n \"status\": \"completed\",\n \"doctor_name\": null,\n \"reporting_date\": null,\n \"annotations\": \"\",\n \"timezone\": \"Europe/Rome\",\n \"language\": \"it\"\n },\n {\n \"exam_id\": \"450\",\n \"partner_name\": \"Demo Partner\",\n \"exam_type\": \"sleep+apnea\",\n \"creation_date\": \"2025-09-10 19:57:07\",\n \"creator\": {\n \"name\": \"John Smith\",\n \"id\": 34\n },\n \"device\": {\n \"producer\": \"Sleepacta\",\n \"vendor_code\": \"25-00010\"\n },\n \"delivery\": {\n \"delivery_id\": \"117\",\n \"account_name\": \"John Smith\",\n \"creation_date\": \"2025-09-05 17:00:00\",\n \"delivery_date\": \"2025-09-05 17:00:00\",\n \"annotations\": \"\"\n },\n \"patient\": {\n \"age\": 54,\n \"nickname\": \"AV\",\n \"gender\": \"M\",\n \"weight\": 80,\n \"height\": 185\n },\n \"start_date\": \"2025-09-05 17:00:00\",\n \"end_date\": \"2025-09-10 19:30:00\",\n \"status\": \"completed\",\n \"doctor_name\": null,\n \"reporting_date\": null,\n \"annotations\": \"\",\n \"timezone\": \"Europe/Rome\",\n \"language\": \"en\"\n }\n ]\n}"}],"_postman_id":"52b76ca9-3380-4cab-a702-a5b9d878fa78"},{"name":"get_device","id":"a299f72c-ce4e-4f88-b36a-d66dc3eacb8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_device?device_code={{DEVICE_CODE}}","description":"Retrieves the details of a specific device by its device code or identifier
\n","urlObject":{"path":["api","get_device"],"host":["{{FRONTEND_BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"the unique identifier of the device to retrieve
\n","type":"text/plain"},"key":"id","value":"{{DEVICE_ID}}"},{"description":{"content":"the alphanumeric code of the device to retrieve
\n","type":"text/plain"},"key":"device_code","value":"{{DEVICE_CODE}}"}],"variable":[]}},"response":[{"id":"d81259f0-7892-466c-87f3-2ed3a5f794ed","name":"get_device_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_device?device_code={{DEVICE_CODE}}","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_device"],"query":[{"key":"id","value":"{{DEVICE_ID}}","description":"the ID of the exam to be returned","disabled":true},{"key":"device_code","value":"{{DEVICE_CODE}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 21 May 2026 13:25:06 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Set-Cookie","value":"PHPSESSID=42b38fftc18s86rquf4ah5hbtn; path=/"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"167"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"device\": {\n \"device_id\": \"143\",\n \"vendor_code\": \"26-00133\",\n \"producer\": \"Sleepacta\",\n \"model\": \"Signal\",\n \"location\": \"Sleepacta Office\",\n \"owner\": \"Sleepacta\",\n \"account_name_filter\": \"\",\n \"creation_date\": \"2026-04-21 20:28:22\",\n \"account_name_filter\": \"\",\n \"is_delivered\": \"1\",\n \"delivery\": {\n \"delivery_id\": \"121\",\n \"account_name\": \"My Account\",\n \"creation_date\": \"2026-04-21 23:10:34\",\n \"delivery_date\": \"2026-04-21 23:10:00\",\n \"annotations\": \"\",\n \"patient_identifier\": \"PN\",\n \"patient_age\": \"33\",\n \"patient_weight\": \"85\",\n \"patient_height\": \"187\",\n \"patient_gender\": \"M\",\n \"patient_external_identifier\": \"my-external-id\"\n }\n }\n}"}],"_postman_id":"a299f72c-ce4e-4f88-b36a-d66dc3eacb8a"},{"name":"update_delivery","id":"b75fc397-37f0-4358-9e93-b1b2cb3664b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"delivery_id\": \"{{DELIVERY_ID}}\",\r\n \"patient_identifier\": \"{{UPDATED_PATIENT_IDENTIFIER}}\",\r\n \"patient_age\": \"{{UPDATED_PATIENT_AGE}}\",\r\n \"patient_gender\": \"{{UPDATED_PATIENT_GENDER}}\",\r\n \"patient_weight\": \"{{UPDATED_PATIENT_WEIGHT}}\",\r\n \"patient_height\": \"{{UPDATED_PATIENT_HEIGHT}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/update_delivery","description":"Updates the patient's metadata of a delivery (only if it hasn't been completed yet).
\nWith the exception of the delivery_id field, all other fields are optional.
API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"{{DELETE_DELIVERY_ID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/delete_delivery","description":"Delete a delivery (only if it hasn't been completed yet).
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"{{UNRELIABLE_EXAM_ID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/mark_exam_as_unreliable","description":"Flags a specific exam as unreliable to exclude it from clinical reporting
\nContains the endpoints that cover the full lifecycle of a sleep exam, from device selection and delivery setup through to raw data upload, exam generation, and result retrieval.
\nThe typical workflow proceeds as follows:
\nget_available_devices: Retrieves the list of devices available for a new delivery.
insert_delivery: Creates a new delivery, associating a device with a patient and configuring the exam type (sleep or sleep+apnea), recording window, and optional plot settings.
get_open_deliveries: Lists deliveries that are still ongoing and have not yet been closed.
upload_raw_data: Uploads the ZIP archive of raw device data, identified by device ID or delivery ID.
create_exam_from_delivery: Generates an exam from a completed delivery. Supports optional date overrides and language selection (it, en, fr, etc.).
get_exam: Retrieves the full details of a single exam by ID. The full_version flag can be set to return the complete dataset.
get_exams: Returns a paginated, filterable list of exams, with support for ordering, date range filtering, status filtering, and patient/account scoping.
get_device: Retrieves device details by device ID or device code.
mark_exam_as_unreliable: Flags a specific exam as unreliable, making it possible to exclude it from downstream processing or reporting.
All endpoints are authenticated and require a valid token in the Authorization header using the APIauth: prefix.
API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{NEW_USERNAME}}\",\r\n \"password\": \"{{NEW_PASSWORD}}\",\r\n \"email\": \"{{NEW_EMAIL}}\",\r\n \"name\": \"{{NEW_FULL_NAME}}\",\r\n \"max_exams\": 10,\r\n \"can_use_only_own_devices\": \"1\",\r\n \"assigned_device_code\": \"{{DEVICE_CODE}}\",\r\n \"can_create_exams\": \"1\",\r\n \"can_view_exams\": \"0\",\r\n \"external_identifier\": \"{{EXTERNAL_IDENTIFIER}}\",\r\n \"notifications_language\": \"en\",\r\n \"is_end_user\": \"1\",\r\n \"age\": 33,\r\n \"gender\": \"M\",\r\n \"height\": 187,\r\n \"weight\": 80\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/insert_account","description":"Creates a new user account with the provided credentials and profile data
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"{{ACCOUNT_ID}}\",\r\n \"username\": \"{{MODIFIED_USERNAME}}\",\r\n \"password\": \"{{MODIFIED_PASSWORD}}\",\r\n \"email\": \"{{MODIFIED_EMAIL}}\",\r\n \"name\": \"{{MODIFIED_FULL_NAME}}\",\r\n \"max_exams\": 5,\r\n \"external_identifier\": \"{{MODIFIED_EXTERNAL_IDENTIFIER}}\",\r\n \"can_use_only_own_devices\": \"1\",\r\n \"can_create_exams\": \"1\",\r\n \"can_view_exams\": \"0\",\r\n \"enabled\": \"1\",\r\n \"assigned_device_code\": \"{{MODIFIED_DEVICE_CODE}}\",\r\n \"notifications_language\": \"en\",\r\n \"is_end_user\": \"1\",\r\n \"age\": 33,\r\n \"gender\": \"M\",\r\n \"height\": 187,\r\n \"weight\": 80\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/update_account","description":"Updates the profile information of an existing user account
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_accounts","description":"Retrieves the list of all accounts accessible to the authenticated user
\n","urlObject":{"path":["api","get_accounts"],"host":["{{FRONTEND_BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"the number of accounts to return (default 10)
\n","type":"text/plain"},"key":"num_records","value":"{{NUM_RECORDS}}"},{"disabled":true,"description":{"content":"the offset of the first record to return (default 1)
\n","type":"text/plain"},"key":"start","value":"{{START}}"},{"disabled":true,"description":{"content":"the field to sort results by (id, creation_date, status)
\n","type":"text/plain"},"key":"order_by","value":"{{ORDER_BY}}"},{"disabled":true,"description":{"content":"the sort direction (asc or desc)
\n","type":"text/plain"},"key":"asc_desc","value":"{{ASC_DESC}}"},{"disabled":true,"description":{"content":"filter by account username
\n","type":"text/plain"},"key":"username","value":"{{USERNAME}}"},{"disabled":true,"description":{"content":"filter by account full name
\n","type":"text/plain"},"key":"name","value":"{{NAME}}"},{"disabled":true,"description":{"content":"filter by account email address
\n","type":"text/plain"},"key":"email","value":"{{EMAIL}}"},{"disabled":true,"description":{"content":"filter by account status (0 for disabled, 1 for enabled)
\n","type":"text/plain"},"key":"enabled","value":"{{ENABLED}}"},{"disabled":true,"description":{"content":"filter by the account's external identifier
\n","type":"text/plain"},"key":"external_identifier","value":"{{EXTERNAL_IDENTIFIER}}"}],"variable":[]}},"response":[{"id":"5226f595-eb49-402b-af3a-b504903458d3","name":"get_accounts_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_accounts?num_records={{NUM_RECORDS}}&start={{START}}&order_by={{ORDER_BY}}&asc_desc={{ASC_DESC}}","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_accounts"],"query":[{"key":"num_records","value":"{{NUM_RECORDS}}","description":"the number of the exams to be returned (default 10)"},{"key":"start","value":"{{START}}","description":"the starting record (default 1)"},{"key":"order_by","value":"{{ORDER_BY}}","description":"order-by clause (\"id\", \"creation_date\", \"status\")"},{"key":"asc_desc","value":"{{ASC_DESC}}","description":"asc/desc ordering (\"asc\" or \"desc\" values)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Jan 2026 11:42:32 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"552"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"x-powered-by","value":"PHP/8.1.33"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=0.099;desc=Process-Time"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=npTvRllBrOUMrEaMRLjCDjA8dMZltvRaWndt5LerJzZN%2FuVjrXv5ZCgCL638dw7Cao7pdr6lMzeOgi8aHwSTZKL4RAxpGLrhoD3%2BL4MnOpKOBxeMksPypRIFH%2BELxg%3D%3D\"}]}"},{"key":"CF-RAY","value":"9c47fcbc2a368062-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"accounts\": [\n {\n \"account_id\": \"1\",\n \"name\": \"John Smith\",\n \"username\": \"john\",\n \"email\": \"johnsmith@themail.com\",\n \"can_create_exams\": \"1\",\n \"can_view_exams\": \"1\",\n \"can_report_exams\": \"1\",\n \"has_admin_features\": \"1\",\n \"can_access_billing_data\": \"1\",\n \"can_create_devices\": \"0\",\n \"can_receive_reporting_requests\": \"1\",\n \"can_use_only_own_devices\": \"0\",\n \"has_advanced_gui_options\": \"0\",\n \"external_identifier\": null,\n \"skip_otp\": \"1\",\n \"is_end_user\": \"0\",\n \"age\": null,\n \"weight\": null,\n \"height\": null,\n \"gender\": null,\n \"assigned_devices\": [\n {\n \"device_id\": \"145\",\n \"vendor_code\": \"26-00135\",\n \"producer\": \"Sleepacta\",\n \"model\": \"Signal\",\n \"location\": \"Sleepacta Office\",\n \"owner\": \"Sleepacta\",\n \"creation_date\": \"2026-04-25 15:14:11\",\n \"account_name_filter\": \"john, other-username\"\n }\n ]\n },\n {\n \"account_id\": \"2\",\n \"name\": \"Seraphina White\",\n \"username\": \"seraphina\",\n \"email\": \"seraphina.white@themail.com\",\n \"can_create_exams\": \"1\",\n \"can_view_exams\": \"1\",\n \"can_report_exams\": \"1\",\n \"has_admin_features\": \"0\",\n \"can_access_billing_data\": \"0\",\n \"can_create_devices\": \"0\",\n \"can_receive_reporting_requests\": \"0\",\n \"can_use_only_own_devices\": \"0\",\n \"has_advanced_gui_options\": \"0\",\n \"external_identifier\": \"the-external-id\",\n \"skip_otp\": \"0\",\n \"is_end_user\": \"1\",\n \"age\": \"37\",\n \"weight\": \"175\",\n \"height\": \"50\",\n \"gender\": \"F\"\n }\n ]\n}"}],"_postman_id":"a15dbcfe-330c-4ed7-aff3-8920b535a58e"}],"id":"2078bdac-9af9-4c1a-aa23-b9b7a72258ae","description":"This folder contains the endpoints for managing partner accounts. It covers the full lifecycle of an account: creating a new account (insert_account), retrieving the list of existing accounts (get_accounts), and updating account details (update_account).
All endpoints are authenticated and require a valid token passed in the Authorization header using the APIauth: prefix.
Key behaviours to be aware of:
\nassigned_device_code can optionally be provided to assign a device to the account. The device must belong to the current partner.max_exams field is optional and can be set to cap the number of exams for an account.can_use_only_own_devices to 1 restricts the account to devices tagged with its username.enabled to 0 via the update endpoint.Sends a password reset email to the user's registered email address
\nResets the user password using a temporary code received via email
\nUpdates the user password after verifying the current credentials
\nContains the endpoints that handle all password-related operations for a user account, covering two distinct flows:
\nforgot_password): Initiates the password reset procedure by sending a temporary reset code to the user's email address.reset_password_by_temporary_code): Completes the reset flow by validating the temporary code and assigning a new password to the account.reset_password): Allows a user to change their password voluntarily, or to update an expired password, by providing their current credentials alongside the new password.API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"exam_id\": \"{{EXAM_ID}}\",\r\n \"nickname\": \"modified-nickname\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/update_patient_nickname","description":"Updates the display nickname for a specific patient record
\nAPI authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"exam_id\": \"{{EXAM_ID}}\",\r\n \"patient_external_identifier\": \"modified-external-identifier\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/update_patient_external_identifier","description":"Updates the external identifier associated with a specific patient record
\nContains the endpoints for managing patient metadata associated with exams.
\nupdate_patient_nickname: Updates the display nickname of the patient linked to a given exam. Both exam_id and nickname are required.update_patient_external_identifier: Updates the external identifier of the patient linked to a given exam. Both exam_id and patient_external_identifier are required. This is useful for aligning patient records with identifiers from external systems.Both endpoints are authenticated and require a valid token in the Authorization header using the APIauth: prefix.
API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_gui_logs_by_delivery_id?delivery_id={{DELIVERY_ID}}","description":"Retrieves all GUI execution logs associated with a specific delivery ID
\n","urlObject":{"path":["api","get_gui_logs_by_delivery_id"],"host":["{{FRONTEND_BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"the number of log entries to return (default 10)
\n","type":"text/plain"},"key":"num_records","value":"{{NUM_RECORDS}}"},{"disabled":true,"description":{"content":"the offset of the first record to return (default 1)
\n","type":"text/plain"},"key":"start","value":"{{START}}"},{"disabled":true,"description":{"content":"the field to sort results by (id, creation_date, status)
\n","type":"text/plain"},"key":"order_by","value":"{{ORDER_BY}}"},{"disabled":true,"description":{"content":"the sort direction (asc or desc)
\n","type":"text/plain"},"key":"asc_desc","value":"{{ASC_DESC}}"},{"description":{"content":"the unique identifier of the delivery whose logs are being retrieved
\n","type":"text/plain"},"key":"delivery_id","value":"{{DELIVERY_ID}}"}],"variable":[]}},"response":[{"id":"1b3e26dd-c673-4314-b8f6-3803016ca034","name":"get_gui_logs_by_delivery_id_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_accounts?num_records={{NUM_RECORDS}}&start={{START}}&order_by={{ORDER_BY}}&asc_desc={{ASC_DESC}}","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_accounts"],"query":[{"key":"num_records","value":"{{NUM_RECORDS}}","description":"the number of the exams to be returned (default 10)"},{"key":"start","value":"{{START}}","description":"the starting record (default 1)"},{"key":"order_by","value":"{{ORDER_BY}}","description":"order-by clause (\"id\", \"creation_date\", \"status\")"},{"key":"asc_desc","value":"{{ASC_DESC}}","description":"asc/desc ordering (\"asc\" or \"desc\" values)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Jan 2026 11:42:32 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"552"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"x-powered-by","value":"PHP/8.1.33"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=0.099;desc=Process-Time"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=npTvRllBrOUMrEaMRLjCDjA8dMZltvRaWndt5LerJzZN%2FuVjrXv5ZCgCL638dw7Cao7pdr6lMzeOgi8aHwSTZKL4RAxpGLrhoD3%2BL4MnOpKOBxeMksPypRIFH%2BELxg%3D%3D\"}]}"},{"key":"CF-RAY","value":"9c47fcbc2a368062-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"gui_logs\": [\n {\n \"log_id\": \"1\",\n \"log_source\": \"signal\",\n \"account_name\": \"Demo User\",\n \"creation_date\": \"2026-03-20 09:25:56\",\n \"log_text\": \"long text...\"\n \n },\n {\n \"log_id\": \"2\",\n \"log_source\": \"signal\",\n \"account_name\": \"Demo User\",\n \"creation_date\": \"2026-03-25 09:23:40\",\n \"log_text\": \"long text...\"\n }\n ]\n}"}],"_postman_id":"d5906d9b-69de-4c56-aa51-ea28a41b735b"},{"name":"log_gui_execution","id":"c5e338d4-ba8d-4594-922c-2187775f1d44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"account_id\": {{ACCOUNT_ID}},\r\n \"delivery_id\": {{DELIVERY_ID}},\r\n \"log_source\": \"{{LOG_SOURCE}}\",\r\n \"log_text\": \"this is a log\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/log_gui_execution","description":"Logs a GUI execution event for tracking and debugging purposes
\nContains the endpoints for recording and retrieving Sleepacta Signal GUI-level execution logs, useful for tracing client-side activity associated with deliveries.
\nlog_gui_execution: Creates a new log entry tied to a specific account and delivery, with a free-text log_text field describing the GUI event being recorded.
get_gui_logs_by_delivery_id: Retrieves a paginated list of GUI logs for a given delivery. Supports filtering and ordering via num_records, start, order_by, and asc_desc parameters.
Both endpoints are authenticated and require a valid token in the Authorization header using the APIauth: prefix.
Retrieves all notifications for the authenticated user
\n","urlObject":{"path":["api","get_notifications"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"144a6c3c-3298-4df9-8d9b-4351bda5b00f","name":"get_notifications","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 20 Mar 2026 16:41:01 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"425"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"x-powered-by","value":"PHP/8.1.34"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"server-timing","value":"rt;dur=0.121;desc=Process-Time"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=snLs0f%2BEL8PHK8j%2BAfHzhe6aviPqahFaMPsooX%2FAWtwz2dF3%2BzB8%2FeIDxL4LcbyHBTevyFdhrLykCNAUMRjXJbzY7Oqma8CgqjrYDGWolsd6c%2BDbCd4%3D\"}]}"},{"key":"CF-RAY","value":"9df6297408091ff7-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"communication\": \"This is a private communication for you.\"\n}"}],"_postman_id":"586be54c-cb88-4055-8346-ad0de42cabdb"}],"id":"d7905ab2-d275-45c0-969d-f30c03f897d7","description":"Contains the endpoint for retrieving private notifications for the authenticated user.
\nget_notifications: Returns any pending private notification addressed to the currently logged-in user. If no notification is present, the response will indicate an empty result.This endpoint is authenticated and requires a valid token in the Authorization header using the APIauth: prefix.
Retrieves the current terms and conditions document for the platform
\n","urlObject":{"path":["api","get_terms_and_conditions&lang={{LANGUAGE}}&html_text={{HTML_TEXT}}"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ffb6e926-26b5-4459-9561-5793d1d454cc","name":"get_terms_and_conditions_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_terms_and_conditions&lang={{LANGUAGE}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Jun 2026 21:32:37 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1191"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"terms_and_condtions\": {\n \"version\": \"v01.00\",\n \"html_text\": false,\n \"language\": \"en\",\n \"text\": \".... T&C text ... \"\n }\n}"}],"_postman_id":"b739229a-6265-4a5a-859b-f0ef1746db07"},{"name":"accept_terms_and_conditions","id":"0c74486b-371a-4f98-b234-770652753cb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/accept_terms_and_conditions","description":"Records the user's acceptance of the current terms and conditions
\n","urlObject":{"path":["api","accept_terms_and_conditions"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7a80724a-a5e1-4f3a-8050-aaa71f003754","name":"accept_terms_and_conditions_response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/accept_terms_and_conditions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Jun 2026 20:54:22 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"103"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"terms_and_conditions_acceptance\": \"2026-06-05 22:54:22\"\n}"}],"_postman_id":"0c74486b-371a-4f98-b234-770652753cb7"}],"id":"7041c97d-f7e4-455e-b487-09940851f281","description":"Contains the endpoints for managing Terms & Conditions acceptance within the DORMI platform.
\nget_terms_and_conditions: Retrieves the current T&C text. Supports an optional lang parameter (default it) and an optional html_text boolean flag to return the content formatted as HTML.
accept_terms_and_conditions: Records the acceptance of the T&C for the currently authenticated user.
The second endpoint is authenticated and requires a valid token in the Authorization header using the APIauth: prefix.
API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"referral_code\": \"DEMO\",\r\n \"end_user_name\": \"Johnn\",\r\n \"end_user_surname\": \"Smith\",\r\n \"end_user_address_street\": \"Via Tal dei tali, 563/A\",\r\n \"end_user_address_postal_code\": \"56121\",\r\n \"end_user_address_city\": \"Pisa\",\r\n \"end_user_address_province\": \"PI\",\r\n \"end_user_country\": \"Italia\",\r\n \"end_user_email\": \"myemail@gmail.com\",\r\n \"end_user_age\": \"52\",\r\n \"end_user_gender\": \"M\",\r\n \"end_user_height\": \"187\",\r\n \"end_user_weight\": \"82\",\r\n \"annotations\": \"test annotation\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/insert_shipment","description":"Creates a new shipment record for dispatching a device to a patient
\nReturns information about the recipient of a shipment.
\nThe online_questionnaire field indicates whether the user has also completed an online questionnaire.
The virtual field indicates that the shipment has not actually taken place (or has not yet taken place)
Contains the endpoint for creating shipment requests on behalf of a partner.
\ninsert_shipment: Registers a new shipment request, including end-user personal details (name, address, contact information) and physical attributes (age, gender, height, weight). An optional annotations field can be used to attach free-text notes to the shipment.This endpoint requires the target partner to have both the \"shipments\" and \"deliveries\" functionalities enabled, and is authenticated via the Authorization header using the APIauth: prefix.
Returns the list of all available questionnaires with their id, title, description, recurring flag, and visibility status
\nReturns the full structure of a single questionnaire, including its topics, questions, answers, rules, and suggestions
\nReturns the list of all recurring questionnaire sessions (placeholders) available for the authenticated account's partner
\npagination
\n","type":"text/plain"},"key":"start","value":"1"},{"disabled":true,"description":{"content":"pagination, max 10
\n","type":"text/plain"},"key":"num_records","value":"10"},{"disabled":true,"description":{"content":"id | title | end_user_name | end_user_surname
\n","type":"text/plain"},"key":"order_by","value":"title"},{"disabled":true,"description":{"content":"asc | desc
\n","type":"text/plain"},"key":"asc_desc","value":"asc"},{"disabled":true,"description":{"content":"partial search
\n","type":"text/plain"},"key":"end_user_name","value":""}],"variable":[]}},"response":[{"id":"69928516-83a3-45ad-89de-928499bd2dec","name":"get_recurring_questionnaires_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_recurring_questionnaires","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_recurring_questionnaires"],"query":[{"key":"start","value":"1","description":"pagination","disabled":true},{"key":"num_records","value":"10","description":"pagination, max 10","disabled":true},{"key":"order_by","value":"title","description":"id | title | end_user_name | end_user_surname","disabled":true},{"key":"asc_desc","value":"asc","description":"asc | desc","disabled":true},{"key":"end_user_name","value":"","description":"partial search","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 04 Jul 2026 09:28:11 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"403"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"recurring_questionnaire_sessions\": [\n {\n \"id\": \"2\",\n \"title\": \"My Recurring Questionnaire\",\n \"annotations\": \"This is an explaination of the functioning of the recurring questionnaire
\",\n \"end_user_name\": \"Johnn\",\n \"end_user_surname\": \"Smith\",\n \"end_user_email\": \"my@email.com\",\n \"public_url\": \"https://public_url/...\"\n }\n ]\n}"}],"_postman_id":"eea5666e-acec-47c9-a0d3-abed85e41edf"},{"name":"get_recurring_questionnaire_session","id":"4f32069b-23e6-45b0-ac0d-2ff902702da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"url":"{{FRONTEND_BASE_URL}}/api/get_recurring_questionnaire_session?id={{RECURRING_QUESTIONNAIRE_SESSION_ID}}&lang={{LANGUAGE}}","description":"Returns the details of a single recurring questionnaire session, including the respondent's information, the public sharing link, and the list of available recurring questionnaires
\nid del placeholder (survey session)
\n","type":"text/plain"},"key":"id","value":"{{RECURRING_QUESTIONNAIRE_SESSION_ID}}"},{"key":"lang","value":"{{LANGUAGE}}"}],"variable":[]}},"response":[{"id":"c4bfa5e3-8864-49a8-86d7-69acbf864df9","name":"get_recurring_questionnaire_session_answer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_recurring_questionnaire?id={{RECURRING_QUESTIONNAIRE_SESSION_ID}}&lang={{LANGUAGE}}","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_recurring_questionnaire"],"query":[{"key":"id","value":"{{RECURRING_QUESTIONNAIRE_SESSION_ID}}"},{"key":"lang","value":"{{LANGUAGE}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 04 Jul 2026 09:29:52 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"496"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"recurring_questionnaire_session\": {\n \"id\": 2,\n \"title\": \"My Recurring Questionnaire\",\n \"annotations\": \"This is an explaination of the functioning of the recurring questionnaire
\",\n \"end_user_name\": \"Johnn\",\n \"end_user_surname\": \"Smith\",\n \"end_user_email\": \"my@email.com\",\n \"public_url\": \"https://public_url/...\",\n \"available_questionnaires\": [\n {\n \"id\": \"10\",\n \"title\": \"Lifestyle\",\n \"description\": \"Lifestyle Monitoring\"\n }\n ]\n }\n}"}],"_postman_id":"4f32069b-23e6-45b0-ac0d-2ff902702da4"},{"name":"get_questionnaire_answers","id":"e6407cbc-e171-4f7c-8a61-ebbab2be751f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"url":"{{FRONTEND_BASE_URL}}/api/get_questionnaire_answers?recurring_questionnaire_session_id={{RECURRING_QUESTIONNAIRE_SESSION_ID}}&lang={{LANGUAGE}}","description":"Returns previously submitted questionnaire answers; when filtered by shipment_id returns { questionnaires: [...] }, when filtered by recurring_questionnaire_session_id returns { rounds: [...] }
\none-shot questionnaire: answers linked to a shipment
\n","type":"text/plain"},"key":"shipment_id","value":"{{SHIPMENT_ID}}"},{"description":{"content":"answers linked to a recurring questionnaire
\n","type":"text/plain"},"key":"recurring_questionnaire_session_id","value":"{{RECURRING_QUESTIONNAIRE_SESSION_ID}}"},{"disabled":true,"description":{"content":"optional filter for a single questionnaire
\n","type":"text/plain"},"key":"questionnaire_id","value":"{{QUESTIONNAIRE_ID}}"},{"disabled":true,"description":{"content":"one-shot questionnaire: answers linked to a delivery
\n","type":"text/plain"},"key":"delivery_id ","value":"{{DELIVERY_ID}}"},{"disabled":true,"description":{"content":"one-shot questionnaire: answers linked to an exam
\n","type":"text/plain"},"key":"exam_id","value":"{{EXAM_ID}}"},{"key":"lang","value":"{{LANGUAGE}}"}],"variable":[]}},"response":[{"id":"2b36a882-b5aa-48bf-9308-b35751257d29","name":"get_questionnaire_answers_response_recurring","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_questionnaire_answers?recurring_questionnaire_id={{RECURRING_QUESTIONNAIRE_ID}}&lang={{LANGUAGE}}","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_questionnaire_answers"],"query":[{"key":"shipment_id","value":"{{SHIPMENT_ID}}","description":"one-shot questionnaire: answers linked to a shipment","disabled":true},{"key":"recurring_questionnaire_id","value":"{{RECURRING_QUESTIONNAIRE_ID}}","description":"answers linked to a recurring questionnaire"},{"key":"questionnaire_id","value":"{{QUESTIONNAIRE_ID}}","description":"optional filter for a single questionnaire","disabled":true},{"key":"delivery_id ","value":"{{DELIVERY_ID}}","description":"one-shot questionnaire: answers linked to a delivery","disabled":true},{"key":"exam_id","value":"{{EXAM_ID}}","description":"one-shot questionnaire: answers linked to an exam","disabled":true},{"key":"lang","value":"{{LANGUAGE}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 04 Jul 2026 09:53:40 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1554"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"recurring_questionnaire_session\": {\n \"id\": 2,\n \"title\": \"My Recurring Questionnaire\",\n \"annotations\": \"This is an explaination of the functioning of the recurring questionnaire
\",\n \"end_user_name\": \"Johnn\",\n \"end_user_surname\": \"Smith\",\n \"end_user_email\": \"my@email.com\",\n \"delivery_id\": \"0\",\n \"public_url\": \"https://public_url/...\",\n \"available_questionnaires\": [\n {\n \"id\": \"10\",\n \"title\": \"Lifestyle\",\n \"description\": \"Lifestyle Monitoring\"\n }\n ]\n },\n \"rounds\": [\n {\n \"round_id\": \"195\",\n \"request_date\": \"2026-07-04 10:35:45\",\n \"questionnaires\": [\n {\n \"title\": \"Lifestyle\",\n \"total_score\": 2,\n \"answers\": [\n {\n \"question_id\": \"138\",\n \"topic\": \"Your Diary\",\n \"question\": \"What did you do today?\",\n \"type\": \"multi\",\n \"answers\": [\n {\n \"answer_id\": \"612\",\n \"answer\": \"I exercised\"\n },\n {\n \"answer_id\": \"616\",\n \"answer\": \"I had dinner less than 3 hours before going to bed\"\n }\n ]\n }\n ],\n \"profiles\": [\n {\n \"title\": \"Physical Activity\",\n \"description\": \"\",\n \"prog\": \"2\"\n },\n {\n \"title\": \"Late dinner\",\n \"description\": \"\",\n \"prog\": \"6\"\n }\n ],\n \"indications\": [],\n \"questionnaire_id\": \"10\"\n }\n ]\n },\n {\n \"round_id\": \"194\",\n \"request_date\": \"2026-07-03 11:42:17\",\n \"questionnaires\": [\n {\n \"title\": \"Lifestyle\",\n \"total_score\": 2,\n \"answers\": [\n {\n \"question_id\": \"138\",\n \"topic\": \"Your Diary\",\n \"question\": \"What did you do today?\",\n \"type\": \"multi\",\n \"answers\": [\n {\n \"answer_id\": \"612\",\n \"answer\": \"I exercised\"\n },\n {\n \"answer_id\": \"615\",\n \"answer\": \"I consumed caffeine (tea, coffee, etc.) less than 3 hours before going to sleep\"\n }\n ]\n }\n ],\n \"profiles\": [\n {\n \"title\": \"Physical Activity\",\n \"description\": \"\",\n \"prog\": \"2\"\n },\n {\n \"title\": \"Caffeine in the Evening\",\n \"description\": \"\",\n \"prog\": \"5\"\n }\n ],\n \"indications\": [],\n \"questionnaire_id\": \"10\"\n }\n ]\n }\n ]\n}"},{"id":"bb12de45-556c-4900-989f-78337e8a07a6","name":"get_questionnaire_answers_one_shot","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"url":{"raw":"{{FRONTEND_BASE_URL}}/api/get_questionnaire_answers?exam_id={{EXAM_ID}}&lang={{LANGUAGE}}","host":["{{FRONTEND_BASE_URL}}"],"path":["api","get_questionnaire_answers"],"query":[{"key":"shipment_id","value":"{{SHIPMENT_ID}}","description":"one-shot questionnaire: answers linked to a shipment","disabled":true},{"key":"recurring_questionnaire_id","value":"{{RECURRING_QUESTIONNAIRE_ID}}","description":"answers linked to a recurring questionnaire","disabled":true},{"key":"questionnaire_id","value":"{{QUESTIONNAIRE_ID}}","description":"optional filter for a single questionnaire","disabled":true},{"key":"delivery_id ","value":"{{DELIVERY_ID}}","description":"one-shot questionnaire: answers linked to a delivery","disabled":true},{"key":"exam_id","value":"{{EXAM_ID}}","description":"one-shot questionnaire: answers linked to an exam"},{"key":"lang","value":"{{LANGUAGE}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 04 Jul 2026 09:55:08 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"3055"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"questionnaires\": [\n {\n \"title\": \"ISI Questionnaire\",\n \"total_score\": 14,\n \"answers\": [\n {\n \"question_id\": \"17\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"In the last 2 weeks, have you had difficulty falling asleep?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"310\",\n \"answer\": \"I had a moderate difficulty\"\n }\n ]\n },\n {\n \"question_id\": \"71\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"In the last 2 weeks, have you had difficulty maintaining sleep once you have fallen asleep?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"315\",\n \"answer\": \"I had a moderate difficulty\"\n }\n ]\n },\n {\n \"question_id\": \"72\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"In the last 2 weeks, have you had problems with early awakening?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"320\",\n \"answer\": \"I had moderate problems\"\n }\n ]\n },\n {\n \"question_id\": \"73\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"How satisfied are you currently with your sleep?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"325\",\n \"answer\": \"Fairly satisfied\"\n }\n ]\n },\n {\n \"question_id\": \"74\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"How much do you think others notice your sleep problem in terms of a worsening quality of life?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"330\",\n \"answer\": \"Partly\"\n }\n ]\n },\n {\n \"question_id\": \"75\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"How worried/distressed are you about the current problem?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"335\",\n \"answer\": \"Partly\"\n }\n ]\n },\n {\n \"question_id\": \"76\",\n \"topic\": \"ISI Profiling\",\n \"question\": \"How much do you think your sleep problems interfere with your ability to function during the day? (e.g. fatigue, work efficiency, daily chores, concentration, memory, mood, etc.).\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"340\",\n \"answer\": \"Fairly\"\n }\n ]\n }\n ],\n \"profiles\": [\n {\n \"title\": \"Subclinical insomnia\",\n \"description\": \"\",\n \"prog\": \"2\"\n }\n ],\n \"indications\": [],\n \"questionnaire_id\": \"4\"\n },\n {\n \"title\": \"STOP-BANG Questionnaire\",\n \"total_score\": 6,\n \"answers\": [\n {\n \"question_id\": \"77\",\n \"topic\": \"STOP Questions\",\n \"question\": \"Do you snore?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"343\",\n \"answer\": \"Yes\"\n }\n ]\n },\n {\n \"question_id\": \"78\",\n \"topic\": \"STOP Questions\",\n \"question\": \"Tired?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"345\",\n \"answer\": \"Yes\"\n }\n ]\n },\n {\n \"question_id\": \"79\",\n \"topic\": \"STOP Questions\",\n \"question\": \"Observed?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"347\",\n \"answer\": \"Yes\"\n }\n ]\n },\n {\n \"question_id\": \"80\",\n \"topic\": \"STOP Questions\",\n \"question\": \"Pressure?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"349\",\n \"answer\": \"Yes\"\n }\n ]\n },\n {\n \"question_id\": \"82\",\n \"topic\": \"BANG Questions\",\n \"question\": \"BMI greater than 35?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"354\",\n \"answer\": \"No\"\n }\n ]\n },\n {\n \"question_id\": \"83\",\n \"topic\": \"BANG Questions\",\n \"question\": \"Are you over 50 years old?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"356\",\n \"answer\": \"No\"\n }\n ]\n },\n {\n \"question_id\": \"81\",\n \"topic\": \"BANG Questions\",\n \"question\": \"Large neck size?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"351\",\n \"answer\": \"Yes\"\n }\n ]\n },\n {\n \"question_id\": \"84\",\n \"topic\": \"BANG Questions\",\n \"question\": \"Is your gender male?\",\n \"type\": \"single\",\n \"answers\": [\n {\n \"answer_id\": \"357\",\n \"answer\": \"Yes\"\n }\n ]\n }\n ],\n \"profiles\": [\n {\n \"title\": \"High Risk of Apnea\",\n \"description\": \"\",\n \"prog\": \"3\"\n }\n ],\n \"indications\": [],\n \"questionnaire_id\": \"6\"\n }\n ]\n}"}],"_postman_id":"e6407cbc-e171-4f7c-8a61-ebbab2be751f"},{"name":"submit_oneshot_questionnaire_answer","id":"ec6f9e7e-6583-4029-aec7-9a37ebdbfbfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"questionnaire_id","value":"{{QUESTIONNAIRE_ID}}"},{"key":"shipment_id","value":"{{SHIPMENT_ID}}","disabled":true},{"key":"delivery_id","value":"{{DELIVERY_ID}}","disabled":true},{"key":"exam_id","value":"{{EXAM_ID}}"},{"key":"device_id","value":"{{DEVICE_ID}}","disabled":true},{"key":"question_id","value":"{{ONE_SHOT_QUESTIONNAIRE_QUESTION_ID}}","description":"0/none= first question; otherwise echo from previous answer
\n"},{"key":"parent_answer_id","value":"","description":"echo from previous answer
\n","disabled":true},{"key":"branch_origin_question_id","value":"","description":"echo from previous answer
\n","disabled":true},{"key":"direction","value":"{{DIRECTION}}","description":"next or prev
\n"},{"key":"answer_ids","value":"{{ONE_SHOT_QUESTIONNAIRE_ANSWER_IDS}}","description":"sected answer(s) Id(s). Can be a CSV (e.g. 612, 613) or array (e.g. answer_ids[]=612&answer_ids[]=616)
\n"},{"key":"free_text","value":"","description":"for free-answers
\n","disabled":true},{"key":"lang","value":"{{LANGUAGE}}","type":"text","uuid":"8a268d60-3c49-4b8c-8cb7-f72fdb76163d"}]},"url":"{{FRONTEND_BASE_URL}}/api/submit_oneshot_questionnaire_answer","description":"Submits an answer step for a one-shot (non-recurring) questionnaire; call repeatedly passing the navigation ids returned in each response until completed is true
\nrequired - must have recurring = 1
\n"},{"key":"recurring_questionnaire_session_id","value":"{{RECURRING_QUESTIONNAIRE_SESSION_ID}}","description":"required
\n"},{"key":"start_new_round","value":"{{START_NEW_ROUND}}","description":"to be used to start a new round, otherwise it's required to pass round_id
\n","type":"text","uuid":"69769f7d-6d62-46f7-acab-a22f98219782"},{"key":"round_id","value":"{{CURR_ROUND_ID}}","description":"continues an existing round
\n"},{"key":"question_id","value":"{{CURR_RECURRING_QUESTION_ID}}","description":"0/none= first question; otherwise echo from previous answer
\n"},{"key":"parent_answer_id","value":"","description":"echo from previous answer
\n","disabled":true},{"key":"branch_origin_question_id","value":"","description":"echo from previous answer
\n","disabled":true},{"key":"direction","value":"{{DIRECTION}}","description":"next or prev
\n"},{"key":"answer_ids","value":"{{CURR_RECURRING_ANSWERS_IDS}}","description":"sected answer(s) Id(s). Can be a CSV (e.g. 612, 613) or array (e.g. answer_ids[]=612&answer_ids[]=616)
\n"},{"key":"free_text","value":"","description":"for free-answers
\n","disabled":true},{"key":"lang","value":"{{LANGUAGE}}","type":"text","uuid":"5714149f-a7a1-4730-b735-73d1e66b418c"}]},"url":"{{FRONTEND_BASE_URL}}/api/submit_recurring_questionnaire_answer","description":"Submits an answer step for a recurring questionnaire linked to a session; use start_new_round to begin a new round or pass round_id to continue an existing one, and repeat until completed is true
\nThis is an explaination of the functioning of the recurring questionnaire
\",\n \"end_user_name\": \"Johnn\",\n \"end_user_surname\": \"Smith\",\n \"end_user_email\": \"my@email.com\",\n \"public_url\": \"http://localhost/sleepacta_frontend/questionnaires/FOqsIffW\",\n \"available_questionnaires\": [\n {\n \"id\": \"10\",\n \"title\": \"Lifestyle\",\n \"description\": \"Lifestyle Monitoring\"\n }\n ]\n }\n }\n}"}],"_postman_id":"0f8e7961-80fd-430f-8d0d-d71fa2ff1112"}],"id":"9eac0c77-a323-4861-9dbc-76c813c33c4d","description":"Contains the endpoints for managing questionnaires and their responses within the Sleepacta platform. It covers two distinct questionnaire types: one-shot questionnaires (linked to a shipment, delivery, exam, or device) and recurring questionnaires (linked to a recurring session with multiple rounds). The folder includes endpoints for listing and retrieving questionnaire structures, managing recurring sessions, submitting answers step by step, and reading previously submitted answers.
\nEndpoints: get_questionnaires, get_questionnaire, get_recurring_questionnaire_sessions, get_recurring_questionnaire_session, get_questionnaire_answers, submit_oneshot_questionnaire_answer, submit_recurring_questionnaire_answer.
\n","_postman_id":"9eac0c77-a323-4861-9dbc-76c813c33c4d"},{"name":"Miscellaneous","item":[{"name":"version","id":"e86b3d90-23e3-4d56-a8c7-715488d6529d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{FRONTEND_BASE_URL}}/api/version","description":"Retrieves the current version information of the API
\n","urlObject":{"path":["api","version"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"603304e5-4ada-4176-bd39-36e9d749cf40","name":"version_response","originalRequest":{"method":"GET","header":[],"url":"{{FRONTEND_BASE_URL}}/api/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 May 2025 15:00:28 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"206"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"X-Powered-By","value":"PHP/8.1.31"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Vary","value":"Accept-Encoding,User-Agent"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server-Timing","value":"rt;dur=0.689;desc=Process-Time"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=DE7RgBx469kXTxhu%2Bostvy1evBBKCGHAnC4rVvH0ytphqb%2B9yv86ZbiEIqsm9%2FqwW1EFosksx0DBKjbzvV5PLysil5bfPEkhP%2FrDPnb7eViMEKTxrSiaNCBljNxM9Q%3D%3D\"}]}"},{"key":"Set-Cookie","value":"PHPSESSID=rpp1qsr1v23b68jekfcq8bo34g; Path=/"},{"key":"CF-RAY","value":"9476dc896fd3c960-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"response\": {\n \"api_data\": {\n \"API version\": \"1.0\",\n \"IP address\": \"10.0.1.36\",\n \"server name\": \"partners-testing.sleepacta.com\",\n \"server port\": \"80\"\n },\n \"signal_metadata\": {\n \"firmware_version\": \"1.23.4\",\n \"gui_version\": \"2.5.23\",\n \"flasher_version\": \"1.5.2\"\n },\n \"signal_metadata_optional\": {\n \"firmware_version\": \"1.23.4\",\n \"gui_version\": \"2.5.23\",\n \"flasher_version\": \"1.5.2\"\n },\n \"signal_gui_urls\": {\n \"win_version\": \"https://www.sleepacta.com/signal_gui/signal_gui.exe\",\n \"mac_version\": \"https://www.sleepacta.com/signal_gui/macos_signal_gui.dmg\"\n },\n \"signal_manuals\": {\n \"ita_version\": \"https://partners.sleepacta.com/user_manual/Dormi_Signal_user_manual_ITA.pdf\",\n \"eng_version\": \"https://partners.sleepacta.com/user_manual/Dormi_Signal_user_manual_ENG.pdf\",\n \"datasheet\": \"https://partners.sleepacta.com/user_manual/signal_datasheet.pdf\"\n },\n \"documentation\": {\n \"additional_analyses\": \"https://partners.sleepacta.com/user_manual/Dormi_Additional_Analyses_Documentation.pdf\",\n \"human_activity_recognition\": \"https://partners.sleepacta.com/user_manual/Dormi_Human_Activity_Recognition.pdf\"\n }\n }\n}"}],"_postman_id":"e86b3d90-23e3-4d56-a8c7-715488d6529d"},{"name":"me","id":"bde34457-30b8-49b0-b474-aa0312a0f93c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/me","description":"Retrieves the profile and session details of the authenticated user
\n","urlObject":{"path":["api","me"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b55169c7-b39c-477a-bfd0-f115441009eb","name":"me_response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Apr 2026 07:08:53 GMT"},{"key":"Server","value":"Apache/2.4.58 (Win64) OpenSSL/3.1.3 PHP/8.2.12"},{"key":"X-Powered-By","value":"PHP/8.2.12"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"521"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": \"Operation executed.\",\n \"response\": {\n \"account_info\": {\n \"account_id\": \"1\",\n \"name\": \"My Name\",\n \"username\": \"my-username\",\n \"email\": \"my@email.com\",\n \"notifications_language\": \"it\",\n \"enabled\": \"1\",\n \"can_create_exams\": \"1\",\n \"can_view_exams\": \"1\",\n \"can_report_exams\": \"1\",\n \"has_admin_features\": \"1\",\n \"can_access_billing_data\": \"1\",\n \"can_create_devices\": \"0\",\n \"can_receive_reporting_requests\": \"0\",\n \"can_use_only_own_devices\": \"0\",\n \"has_advanced_gui_options\": \"0\",\n \"has_beta_firmware_access\": \"1\",\n \"external_identifier\": \"my-external-id\",\n \"skip_otp\": \"0\",\n \"is_end_user\": \"0\",\n \"age\": null,\n \"weight\": null,\n \"height\": null,\n \"gender\": null\n },\n \"partner_info\": {\n \"id\": \"5\",\n \"partner_name\": \"Demo Partner\",\n \"partner_timezone\": \"Europe/Rome\",\n \"partner_dormi_apnea_mode\": \"lite\",\n \"partner_additional_analysis\": \"altertness,circadian-modeling,cosinor-fitting,functional-linear-model,inertial-breathing-rate,inertial-heart-rate,non-parametric-variables,sleepiness,step-detection,temperature-apnea\",\n \"partner_device_configurations\": [],\n \"partner_minimum_firmware_version\": \"1.24.22\"\n },\n \"linked_partners\": [\n {\n \"partner_id\": \"6\",\n \"partner_name\": \"Demo Partner\"\n }\n ],\n \"terms_and_conditions\": {\n \"approval_date\": \"2026-06-16 07:42:49\",\n \"version\": \"v01.00\",\n \"current_version\": \"v01.00\"\n }\n }\n}"}],"_postman_id":"bde34457-30b8-49b0-b474-aa0312a0f93c"},{"name":"get_partner_logo","id":"c9af86f5-0cdc-424b-843d-ad968c120234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/get_partner_logo","description":"Retrieves the logo image associated with the current partner
\n","urlObject":{"path":["api","get_partner_logo"],"host":["{{FRONTEND_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9af86f5-0cdc-424b-843d-ad968c120234"},{"name":"set_language","id":"05cdc82a-f469-497e-aedc-0baeb745ba16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"APIauth: {{AUTH_TOKEN}}","description":"API authentication token in the format: APIauth:
\n"}],"body":{"mode":"raw","raw":"{\r\n \"lang\": \"{{LANGUAGE}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{FRONTEND_BASE_URL}}/api/set_language","description":"Set the preferred language for the currently logged account
\nContains utility endpoints that provide general-purpose information about the API and the authenticated user's context.
\nversion: Returns the current version of the API. This is a public endpoint and does not require authentication.
me: Returns profile and context information for the currently authenticated user.
get_partner_logo: Returns the logo of the partner associated with the current session, in JPG/PNG format.
Authenticated endpoints require a valid token in the Authorization header using the APIauth: prefix.