\",\n \"full_address\": \"10 Sample Street, Exampletown, EX1 2AB\"\n },\n \"notes\": [\n {\n \"note\": \"Dummy note: this action was previously closed in a legacy system.\",\n \"created_at\": \"2025-01-16 10:15:00\",\n \"updated_at\": \"2025-01-16 10:15:00\",\n \"created_by\": {\n \"name\": \"Example System\",\n \"email\": \"system@example.com\"\n },\n \"attachments\": [],\n \"tags\": []\n },\n {\n \"note\": \"Dummy note: example note added to the action for documentation purposes.\",\n \"created_at\": \"2025-01-16 11:05:00\",\n \"updated_at\": \"2025-01-16 11:05:00\",\n \"created_by\": {\n \"name\": \"Jordan Taylor\",\n \"email\": \"jordan.taylor@example.com\"\n },\n \"attachments\": [],\n \"tags\": []\n }\n ],\n \"photos\": [],\n \"flags\": [],\n \"logs\": [\n {\n \"message\": \"Dummy log: note added and action record updated.\",\n \"logged_at\": \"09:22am 6th Feb 2025\",\n \"user\": {\n \"name\": \"Example System\",\n \"email\": \"system@example.com\"\n }\n }\n ]\n }\n}"}],"_postman_id":"fc072fef-8ada-4322-bdc7-7618eeeab2e3"},{"name":"Close an Action","id":"a1958c74-c035-433e-b3ff-ee634971fbe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"evidence","description":"File. Optional. 1mb max filesize.
\n","type":"file","value":null},{"key":"note","value":"A completion note","description":"String. Optional.
\n","type":"text"},{"key":"completed_by_id","value":"{{integer}}","description":"Integer. Optional.
\n","type":"text"},{"key":"approved_by_id","value":"{{integer}}","description":"Integer. Optional.
\n","type":"text"}]},"url":"{{public_api_url}}action/{{action_id}}/close","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{action_id}}","close"],"host":["{{public_api_url}}action"],"query":[],"variable":[]}},"response":[{"id":"2ecf3d85-142c-4b1a-afba-23b56e59cbdc","name":"Close an Action","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"evidence","description":"File. Optional. 1mb max filesize.","type":"file","value":null},{"key":"note","value":"A completion note","description":"String. Optional.","type":"text"},{"key":"completed_by_id","value":"{{integer}}","description":"Integer. Optional.","type":"text"},{"key":"approved_by_id","value":"{{integer}}","description":"Integer. Optional.","type":"text"}]},"url":"{{public_api_url}}action/{{action_id}}/close"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": [\n \"Action closed\"\n ]\n}"}],"_postman_id":"a1958c74-c035-433e-b3ff-ee634971fbe4"},{"name":"Reassign Action","id":"edd2cbed-c45e-4411-87b7-a25722f768e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"owner_id\": {{integer}},\n \"team_id\": {{integer}}\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}action/{{action_id}}/reassign","description":"Change the ownership of an action. Both owner_id and team_id are optional, but one of them must be present.
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{action_id}}","reassign"],"host":["{{public_api_url}}action"],"query":[],"variable":[]}},"response":[{"id":"019c1dd7-808a-492c-a257-8aac0cdf04e2","name":"Reassign Action","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"owner_id\": {{integer}},\n \"team_id\": {{integer}}\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}action/{{action_id}}/reassign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": [\n \"Action reassigned\"\n ]\n}"}],"_postman_id":"edd2cbed-c45e-4411-87b7-a25722f768e0"},{"name":"Update Status","id":"9303ef57-8ed9-4567-96cf-ff0d149239fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action_status_id\": {{integer}},\n \"completed_by_id\": {{integer}}\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}action/{{action_id}}/change-status","description":"This will change the action to any status other than Closed (to close an action use the \"Close an Action\" endpoint).
\naction_status_id must be either 1, 2 or 3:
\n1 - Open
2 - Sent for Approval
3 - Rejected
\nIf the new status is 2 you can optionally send the completed_by_id, which is the user_id of the user who completed the action. If omitted the completed_by user will be the authenticated API user.
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{action_id}}","change-status"],"host":["{{public_api_url}}action"],"query":[],"variable":[]}},"response":[{"id":"f3bf800c-f925-4f8f-9283-ffd0c18cb807","name":"Update Status","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action_status_id\": {{integer}},\n \"completed_by_id\": {{integer}}\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}action/{{action_id}}/change-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": [\n \"Action status updated\"\n ]\n}"}],"_postman_id":"9303ef57-8ed9-4567-96cf-ff0d149239fb"}],"id":"da018ec4-7e24-4c77-a4a8-b37cb5f02131","_postman_id":"da018ec4-7e24-4c77-a4a8-b37cb5f02131","description":""},{"name":"Asset","item":[{"name":"Get Paginated Assets","id":"8a8b22b7-ca77-4365-9560-2c4debf58315","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}asset","description":"Returns a paginated list of assets. Call with ?page={{pageNumber}} to get further pages.
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"host":["{{public_api_url}}asset"],"query":[{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"created_since","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"created_before","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"updated_since","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"updated_before","value":""},{"disabled":true,"description":{"content":"Optional. Integer. Default: 1. The page number of the results to fetch.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Optional. Integer. Default: 15. The number of results per page.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Optional. Boolean. Default: false. Return a more limited data set.
\n","type":"text/plain"},"key":"shallow","value":""}],"variable":[]}},"response":[{"id":"531bf38a-6529-4d4b-adf2-69ffc410bc17","name":"Get Paginated Assets","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{public_api_url}}asset","host":["{{public_api_url}}asset"],"query":[{"key":"created_since","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"created_before","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"updated_since","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"updated_before","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"page","value":"","description":"Optional. Integer. Default: 1. The page number of the results to fetch.","disabled":true},{"key":"limit","value":"","description":"Optional. Integer. Default: 15. The number of results per page.","disabled":true},{"key":"shallow","value":"","description":"Optional. Boolean. Default: false. Return a more limited data set.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"2025-01-10 09:15:30\",\n \"asset_type\": \"Example Appliance\",\n \"compliant\": true,\n \"inspections\": [\n {\n \"certificate_id\": \"\",\n \"compliant\": true,\n \"values\": {\n \"Appliance Details - Item No\": \"1\",\n \"Appliance Details - Location\": \"Example Room\",\n \"Appliance Details - Type\": \"EXAMPLE_TYPE\",\n \"Appliance Details - Make\": \"EXAMPLE_MAKE\",\n \"Appliance Details - Model\": \"EXAMPLE_MODEL\",\n \"Appliance Details - Owned By\": \"Example Owner\",\n \"Appliance Details - Flue Type\": \"N/A\",\n \"Inspection Details - Operating Pressure mbar or Heat Input Kw\": \"N/A\",\n \"Inspection Details - Safety Device Correct Operation\": \"N/A\",\n \"Inspection Details - Ventilation Satisfactory\": \"N/A\",\n \"Inspection Details - Visual Condition of Flue\": \"N/A\",\n \"Inspection Details - Flue Flow Test\": \"N/A\",\n \"Inspection Details - Spillage Test\": \"N/A\",\n \"Inspection Details - CO ppm\": \"N/A\",\n \"Inspection Details - CO Ratio\": \"N/A\",\n \"Inspection Details - CO2%\": \"N/A\",\n \"Appliance Serviced\": \"N/A\",\n \"Inspection Details - Appliance Safe to Use\": \"N/A\",\n \"Defects Identified\": \"None recorded (dummy).\",\n \"GIUSP Classification\": \"N/A\",\n \"Warning Advisory Record Provided\": \"N/A\",\n \"Warning Notice Number\": \"WARN-EXAMPLE-0001\"\n },\n \"faults\": [\n {\n \"id\": \"\",\n \"message\": \"Dummy fault: example issue found during inspection.\",\n \"reviewed\": true,\n \"status\": \"Example Status\",\n \"corrective_action\": \"Dummy corrective action: schedule remedial works.\",\n \"compliant\": true\n },\n {\n \"id\": \"\",\n \"message\": \"Dummy fault: required field not completed in inspection record.\",\n \"reviewed\": true,\n \"status\": \"Example Status\",\n \"corrective_action\": \"Dummy corrective action: update inspection record.\",\n \"compliant\": true\n }\n ],\n \"logs\": []\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_at\": \"2025-01-10 09:15:30\",\n \"asset_type\": \"Example System\",\n \"compliant\": true,\n \"inspections\": [\n {\n \"certificate_id\": \"\",\n \"compliant\": true,\n \"values\": {\n \"Appliance Details - Item No\": \"2\",\n \"Appliance Details - Location\": \"Example Room\",\n \"Appliance Details - Type\": \"EXAMPLE_TYPE\",\n \"Appliance Details - Make\": \"EXAMPLE_MAKE\",\n \"Appliance Details - Model\": \"EXAMPLE_MODEL\",\n \"Appliance Details - Owned By\": \"Example Owner\",\n \"Appliance Details - Flue Type\": \"EXAMPLE_FLUE\",\n \"Inspection Details - Operating Pressure mbar or Heat Input Kw\": \"N/A\",\n \"Inspection Details - Safety Device Correct Operation\": \"N/A\",\n \"Inspection Details - Ventilation Satisfactory\": \"Yes\",\n \"Inspection Details - Visual Condition of Flue\": \"Pass\",\n \"Inspection Details - Flue Flow Test\": \"N/A\",\n \"Inspection Details - Spillage Test\": \"N/A\",\n \"Inspection Details - CO ppm\": \"N/A\",\n \"Inspection Details - CO Ratio\": \"0.0000\",\n \"Inspection Details - CO2%\": \"N/A\",\n \"Appliance Serviced\": \"Yes\",\n \"Inspection Details - Appliance Safe to Use\": \"Yes\",\n \"Defects Identified\": \"None recorded (dummy).\",\n \"GIUSP Classification\": \"N/A\",\n \"Warning Advisory Record Provided\": \"No\",\n \"Warning Notice Number\": \"WARN-EXAMPLE-0002\"\n },\n \"faults\": [\n {\n \"id\": \"\",\n \"message\": \"Dummy fault: additional check required for this appliance.\",\n \"reviewed\": true,\n \"status\": \"Example Status\",\n \"corrective_action\": \"Dummy corrective action: complete missing check and re-upload.\",\n \"compliant\": true\n }\n ],\n \"logs\": []\n }\n ]\n }\n ],\n \"first_page_url\": \"{{public_domain}}asset?page=1\",\n \"from\": 1,\n \"last_page\": 4,\n \"last_page_url\": \"{{public_domain}}asset?page=4\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}asset?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"{{public_domain}}asset?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}asset?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}asset?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}asset?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"{{public_domain}}asset?page=2\",\n \"path\": \"{{public_domain}}asset\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 15,\n \"total\": 55\n }\n}"}],"_postman_id":"8a8b22b7-ca77-4365-9560-2c4debf58315"},{"name":"Get an Asset","id":"344bc475-d199-4a53-b977-e369a2fd4640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}asset/{{asset_id}}","description":"Return the asset object
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{asset_id}}"],"host":["{{public_api_url}}asset"],"query":[],"variable":[]}},"response":[{"id":"b1cb195d-e5b8-451a-b7d9-029fe4c679b1","name":"Get an Asset","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}asset/{{asset_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"2025-02-14 10:20:30\",\n \"asset_type\": \"Example Circuit Ring\",\n \"compliant\": true,\n \"inspections\": [\n {\n \"certificate_id\": \"\",\n \"compliant\": true,\n \"values\": {\n \"Circuit Designation of Consumer Unit\": \"Example Distribution Board\",\n \"Circuit Location\": \"Example Location - Consumer Unit Cupboard\",\n \"Circuit Details: Ring ID\": \"R-01\",\n \"Circuit Details: Circuit Designation\": \"Example Circuit\",\n \"Circuit Details: Type of Wiring\": \"EX\",\n \"Circuit Details: Reference Method\": \"EX\",\n \"Circuit Details: Number of Points Served\": \"8\",\n \"Circuit Details: Circuit Conductors CSA - Live mm2\": \"2.5\",\n \"Circuit Details: Circuit Conductors CSA - CPC mm2\": \"1.5\",\n \"Circuit Details: Max Disconnect Time Permitted by BS7671\": \"0.4\",\n \"Circuit Details: Overcurrent Protective Devices BS(EN)\": \"EX-60898\",\n \"Circuit Details: Overcurrent Protective Devices Type No\": \"C\",\n \"Circuit Details: Overcurrent Protective Devices Rating A\": \"20\",\n \"Circuit Details: Overcurrent Protective Devices Capacity kA\": \"6\",\n \"Circuit Details: RCD Operating Current mA\": \"30\",\n \"Circuit Details: Maximum Zs Permitted\": \"2.50\",\n \"Circuit Details: Circuit Impedances (Ohms) - Ring Final Circuits Only - r1 (Line)\": \"N/A\",\n \"Circuit Details: Circuit Impedances (Ohms) - Ring Final Circuits Only - rn (Neutral)\": \"N/A\",\n \"Circuit Details: Circuit Impedances (Ohms) - Ring Final Circuits Only - r2 (CPC)\": \"N/A\",\n \"Circuit Details: Circuit Impedances (Ohms) - All Circuits - R1+R2\": \"OK\",\n \"Circuit Details: Circuit Impedances (Ohms) - All Circuits - R2\": \"N/A\",\n \"Circuit Details: Insulation Resistance Live - Live MΩ\": \"N/A\",\n \"Circuit Details: Insulation Resistance Live - Earth MΩ\": \"200\",\n \"Circuit Details: Polarity\": \"Pass\",\n \"Circuit Details: Maximum Measured Earth Fault Loop Impedance Zs Ω\": \"OK\",\n \"Circuit Details: RCD - Disconnection Time At 1∆n ms\": \"18.0\",\n \"Circuit Details: RCD - Disconnection Time At 5∆n ms\": \"9.0\",\n \"Circuit Details: RCD - Test Button Operation\": \"Pass\"\n },\n \"faults\": [],\n \"logs\": []\n }\n ]\n }\n}"}],"_postman_id":"344bc475-d199-4a53-b977-e369a2fd4640"},{"name":"Get a Certificates Assets","id":"49028029-a23b-43dd-9a06-86f70dbb4e06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{public_api_url}}certificate/{{certificate_id}}/asset-data","description":"Return all asset data for this certificate
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{certificate_id}}","asset-data"],"host":["{{public_api_url}}certificate"],"query":[],"variable":[]}},"response":[{"id":"15fb5e84-0454-420d-a6a8-31a53ca36661","name":"Get a Certificates Assets","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{public_api_url}}certificate/{{certificate_id}}/asset-data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"compliant\": true,\n \"created_at\": \"2026-03-01 10:15:00\",\n \"asset\": {\n \"asset_type\": \"Example Appliance Type (e.g., Gas Cooker)\",\n \"compliant\": true\n },\n \"values\": {\n \"Appliance Details - Item No\": \"2\",\n \"Appliance Details - Location\": \"Example Location (e.g., Kitchen)\",\n \"Appliance Details - Type\": \"Example Type\",\n \"Appliance Details - Make\": \"Example Make\",\n \"Appliance Details - Model\": \"Example Model\",\n \"Appliance Details - Owned By\": \"Example Owner (e.g., Landlord)\",\n \"Appliance Details - Flue Type\": \"N/A\",\n \"Inspection Details - Operating Pressure mbar or Heat Input Kw\": \"Example value\",\n \"Inspection Details - Safety Device Correct Operation\": \"Example value\",\n \"Inspection Details - Ventilation Satisfactory\": \"Example value\",\n \"Inspection Details - Visual Condition of Flue\": \"Example value\",\n \"Inspection Details - Flue Flow Test\": \"Example value\",\n \"Inspection Details - Spillage Test\": \"Example value\",\n \"Inspection Details - CO ppm\": \"Example value\",\n \"Inspection Details - CO Ratio\": \"Example value\",\n \"Inspection Details - CO2%\": \"Example value\",\n \"Appliance Serviced\": \"Example value\",\n \"Inspection Details - Appliance Safe to Use\": \"Example value\",\n \"Defects Identified\": \"Example defects text for documentation purposes.\",\n \"GIUSP Classification\": \"Example classification\",\n \"Warning Advisory Record Provided\": \"Example value\",\n \"Warning Notice Number\": \"\"\n },\n \"faults\": [\n {\n \"id\": \"\",\n \"message\": \"Example fault message for documentation purposes.\",\n \"reviewed\": true,\n \"status\": \"Example Status\",\n \"corrective_action\": \"Example corrective action text.\",\n \"compliant\": true\n },\n {\n \"id\": \"\",\n \"message\": \"Example fault message for documentation purposes.\",\n \"reviewed\": true,\n \"status\": \"Example Status\",\n \"corrective_action\": \"Example corrective action text.\",\n \"compliant\": true\n }\n ],\n \"logs\": []\n },\n {\n \"compliant\": true,\n \"created_at\": \"2026-03-01 10:15:00\",\n \"asset\": {\n \"asset_type\": \"Example Appliance Type (e.g., Boiler)\",\n \"compliant\": true\n },\n \"values\": {\n \"Appliance Details - Item No\": \"3\",\n \"Appliance Details - Location\": \"Example Location (e.g., Kitchen)\",\n \"Appliance Details - Type\": \"Example Type (e.g., Combi)\",\n \"Appliance Details - Make\": \"Example Make\",\n \"Appliance Details - Model\": \"Example Model\",\n \"Appliance Details - Owned By\": \"Example Owner (e.g., Landlord)\",\n \"Appliance Details - Flue Type\": \"Example Flue Type\",\n \"Inspection Details - Operating Pressure mbar or Heat Input Kw\": \"Example value\",\n \"Inspection Details - Safety Device Correct Operation\": \"Example value\",\n \"Inspection Details - Ventilation Satisfactory\": \"Example value\",\n \"Inspection Details - Visual Condition of Flue\": \"Example value\",\n \"Inspection Details - Flue Flow Test\": \"Example value\",\n \"Inspection Details - Spillage Test\": \"Example value\",\n \"Inspection Details - CO ppm\": \"Example value\",\n \"Inspection Details - CO Ratio\": \"Example value\",\n \"Inspection Details - CO2%\": \"Example value\",\n \"Appliance Serviced\": \"Example value\",\n \"Inspection Details - Appliance Safe to Use\": \"Example value\",\n \"Defects Identified\": \"Example defects text for documentation purposes.\",\n \"GIUSP Classification\": \"Example classification\",\n \"Warning Advisory Record Provided\": \"Example value\",\n \"Warning Notice Number\": \"\"\n },\n \"faults\": [\n {\n \"id\": \"\",\n \"message\": \"Example fault message for documentation purposes.\",\n \"reviewed\": true,\n \"status\": \"Example Status\",\n \"corrective_action\": \"Example corrective action text.\",\n \"compliant\": true\n }\n ],\n \"logs\": []\n }\n]"}],"_postman_id":"49028029-a23b-43dd-9a06-86f70dbb4e06"}],"id":"483939f5-780e-4dfa-89b0-3c87cd4e9fb0","_postman_id":"483939f5-780e-4dfa-89b0-3c87cd4e9fb0","description":""},{"name":"Certificate","item":[{"name":"Get Paginated Certificates","id":"bd918de0-4ce3-443f-8cf7-98dea6f5109f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}certificate","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"host":["{{public_api_url}}certificate"],"query":[{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"created_since","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"created_before","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"updated_since","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"updated_before","value":""},{"disabled":true,"description":{"content":"Optional. Integer. Default: 1. The page number of the results to fetch.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Optional. Integer. Default: 15. The number of results per page.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Optional. Boolean. Default: false. Return a more limited data set.
\n","type":"text/plain"},"key":"shallow","value":""}],"variable":[]}},"response":[{"id":"30b5da76-fca2-437b-935d-cac0f8155189","name":"Get Paginated Certificates","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{public_api_url}}certificate","host":["{{public_api_url}}certificate"],"query":[{"key":"created_since","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"created_before","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"updated_since","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"updated_before","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"page","value":"","description":"Optional. Integer. Default: 1. The page number of the results to fetch.","disabled":true},{"key":"limit","value":"","description":"Optional. Integer. Default: 15. The number of results per page.","disabled":true},{"key":"shallow","value":"","description":"Optional. Boolean. Default: false. Return a more limited data set.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 2,\n \"data\": [\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"document_id\": \"\",\n \"issue_date\": \"2025-02-01\",\n \"next_due_date\": \"2026-02-01\",\n \"document_url\": \"https://example.com/abc.pdf\",\n \"values\": {\n \"Certificate Number\": \"\",\n \"Certificate Title\": \"EXAMPLE CERTIFICATE TITLE\",\n \"Identifier Heading\": \"EXAMPLE IDENTIFIER\",\n \"UPRN\": \"\",\n \"Gas Meter Location\": \"Example Location\",\n \"Visual Inspection of Gas Pipework\": \"Pass\",\n \"Equipotential Bonding Correct\": \"Pass\",\n \"Concealed Flue\": \"No\",\n \"Gas Installation Tightness Test\": \"Pass\",\n \"Emergency Control Accessible\": \"Pass\",\n \"Engineer Notes\": \"Dummy notes for documentation only.\",\n \"Landlord Name\": \"Example Landlord\",\n \"Contractor Name\": \"Example Contractor Ltd\",\n \"Alarm\": \"EXAMPLE ALARM\",\n \"Type\": \"Mains\",\n \"Location\": \"Example Room\",\n \"Tested\": \"YES\",\n \"Pass/Fail\": \"Pass\",\n \"Alarm Expiry\": \"2027-01\",\n \"Remedial Action Taken\": \"None (dummy).\",\n \"Tested By: Name\": \"Jordan Taylor\",\n \"Tested By: Signature\": \"EXAMPLE_SIGNATURE_1\",\n \"Tested By: Date\": \"2025-02-01\",\n \"Landlord Signature\": \"EXAMPLE_LANDLORD_SIGNATURE\"\n }\n },\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"document_id\": \"\",\n \"issue_date\": \"2025-01-15\",\n \"next_due_date\": \"2026-01-15\",\n \"document_url\": \"https://example.com/xyz.pdf\",\n \"values\": {\n \"Certificate Number\": \"\",\n \"Certificate Title\": \"EXAMPLE CERTIFICATE TITLE\",\n \"Identifier Heading\": \"EXAMPLE IDENTIFIER\",\n \"UPRN\": \"\",\n \"Gas Meter Location\": \"Example Location\",\n \"Visual Inspection of Gas Pipework\": \"Yes\",\n \"Equipotential Bonding Correct\": \"Yes\",\n \"Concealed Flue\": \"No\",\n \"Gas Installation Tightness Test\": \"Pass\",\n \"Emergency Control Accessible\": \"Yes\",\n \"Engineer Notes\": \"Dummy notes for documentation only.\",\n \"Landlord Name\": \"Example Landlord\",\n \"Contractor Name\": \"Example Contractor Ltd\",\n \"Alarm\": \"EXAMPLE ALARM\",\n \"Type\": \"SMOKEALARM\",\n \"Location\": \"Example Hallway\",\n \"Tested\": \"YES\",\n \"Pass/Fail\": \"Pass\",\n \"Alarm Expiry\": \"2027-06\",\n \"Remedial Action Taken\": \"None (dummy).\",\n \"Tested By: Name\": \"Casey Morgan\",\n \"Tested By: Signature\": \"EXAMPLE_SIGNATURE_2\",\n \"Tested By: Date\": \"2025-01-15\",\n \"Landlord Signature\": \"EXAMPLE_LANDLORD_SIGNATURE\"\n }\n }\n ],\n \"first_page_url\": \"{{public_domain}}certificate?page=1\",\n \"from\": 16,\n \"last_page\": 4,\n \"last_page_url\": \"{{public_domain}}certificate?page=4\",\n \"links\": [\n {\n \"url\": \"{{public_domain}}certificate?page=1\",\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}certificate?page=1\",\n \"label\": \"1\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}certificate?page=2\",\n \"label\": \"2\",\n \"active\": true\n },\n {\n \"url\": \"{{public_domain}}certificate?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}certificate?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}certificate?page=3\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"{{public_domain}}certificate?page=3\",\n \"path\": \"{{public_domain}}certificate\",\n \"per_page\": 15,\n \"prev_page_url\": \"{{public_domain}}certificate?page=1\",\n \"to\": 30,\n \"total\": 60\n }\n}"}],"_postman_id":"bd918de0-4ce3-443f-8cf7-98dea6f5109f"},{"name":"Get Certificate","id":"5c32fe2f-ec57-4501-a58e-8d9cfec56f71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}certificate/{{certificate_id}}","description":"\nRequires: This endpoint requires an API role of API Client or API Contractor
\n
\n","urlObject":{"path":["{{certificate_id}}"],"host":["{{public_api_url}}certificate"],"query":[],"variable":[]}},"response":[{"id":"f8955bf5-aaef-4770-b3bf-bbba33395ec2","name":"Get Certificate","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}certificate/{{certificate_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"id\": \"\",\n \"property_id\": \"\",\n \"document_id\": \"\",\n \"issue_date\": \"2025-02-01\",\n \"next_due_date\": \"2026-02-01\",\n \"document_url\": \"https://example.com/abc.pdf\",\n \"values\": {\n \"Certificate Number\": \"\",\n \"Certificate Title\": \"EXAMPLE CERTIFICATE TITLE\",\n \"Identifier Heading\": \"EXAMPLE IDENTIFIER\",\n \"UPRN\": \"\",\n \"Gas Meter Location\": \"Example Location\",\n \"Visual Inspection of Gas Pipework\": \"Pass\",\n \"Equipotential Bonding Correct\": \"Pass\",\n \"Concealed Flue\": \"No\",\n \"Gas Installation Tightness Test\": \"Pass\",\n \"Emergency Control Accessible\": \"Pass\",\n \"Engineer Notes\": \"Dummy notes for documentation only.\",\n \"Landlord Name\": \"Example Landlord\",\n \"Contractor Name\": \"Example Contractor Ltd\",\n \"Alarm\": \"EXAMPLE ALARM\",\n \"Type\": \"Mains\",\n \"Location\": \"Example Room\",\n \"Tested\": \"YES\",\n \"Pass/Fail\": \"Pass\",\n \"Alarm Expiry\": \"2027-01\",\n \"Remedial Action Taken\": \"None (dummy).\",\n \"Tested By: Name\": \"Jordan Taylor\",\n \"Tested By: Signature\": \"EXAMPLE_SIGNATURE_1\",\n \"Tested By: Date\": \"2025-02-01\",\n \"Landlord Signature\": \"EXAMPLE_LANDLORD_SIGNATURE\"\n }\n }\n}"}],"_postman_id":"5c32fe2f-ec57-4501-a58e-8d9cfec56f71"},{"name":"Search Certificates","id":"8f26096b-f8d2-409a-b300-e022760cb031","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"search_term\": \"Your search text\"\n}"},"url":"{{public_api_url}}certificate/search","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["search"],"host":["{{public_api_url}}certificate"],"query":[],"variable":[]}},"response":[{"id":"5905fb0c-ceda-42e9-9a31-37798c014cde","name":"Search Certificates","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"search_term\": \"Your search text\"\n}"},"url":"{{public_api_url}}certificate/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Search results: 1\",\n \"data\": [\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"document_id\": \"\",\n \"issue_date\": \"2025-02-01\",\n \"next_due_date\": \"2026-02-01\",\n \"document_url\": \"https://example.com/abc.pdf\",\n \"values\": {\n \"Certificate Number\": \"\",\n \"Certificate Title\": \"EXAMPLE CERTIFICATE TITLE\",\n \"Identifier Heading\": \"EXAMPLE IDENTIFIER\",\n \"UPRN\": \"\",\n \"Gas Meter Location\": \"Example Location\",\n \"Visual Inspection of Gas Pipework\": \"Pass\",\n \"Equipotential Bonding Correct\": \"Pass\",\n \"Concealed Flue\": \"No\",\n \"Gas Installation Tightness Test\": \"Pass\",\n \"Emergency Control Accessible\": \"Pass\",\n \"Engineer Notes\": \"Dummy notes for documentation only.\",\n \"Landlord Name\": \"Example Landlord\",\n \"Contractor Name\": \"Example Contractor Ltd\",\n \"Alarm\": \"EXAMPLE ALARM\",\n \"Type\": \"Mains\",\n \"Location\": \"Example Room\",\n \"Tested\": \"YES\",\n \"Pass/Fail\": \"Pass\",\n \"Alarm Expiry\": \"2027-01\",\n \"Remedial Action Taken\": \"None (dummy).\",\n \"Tested By: Name\": \"Jordan Taylor\",\n \"Tested By: Signature\": \"EXAMPLE_SIGNATURE_1\",\n \"Tested By: Date\": \"2025-02-01\",\n \"Landlord Signature\": \"EXAMPLE_LANDLORD_SIGNATURE\"\n }\n }\n ]\n}"}],"_postman_id":"8f26096b-f8d2-409a-b300-e022760cb031"}],"id":"edd1389a-8556-41f1-87c7-7f0e579c82eb","_postman_id":"edd1389a-8556-41f1-87c7-7f0e579c82eb","description":""},{"name":"Compliance Stream","item":[{"name":"Add Compliance Stream to Unit","id":"18ab51bd-74cb-4053-8851-bad640b1c27c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"compliance_stream_id\": {{integer}},\n\t\"unit_id\": {{integer}}\n}"},"url":"{{public_api_url}}compliance-stream/attach","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["attach"],"host":["{{public_api_url}}compliance-stream"],"query":[],"variable":[]}},"response":[],"_postman_id":"18ab51bd-74cb-4053-8851-bad640b1c27c"},{"name":"Remove Compliance Stream from Unit","id":"72f677f8-25a7-42ab-84cf-8944dc81522a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"compliance_stream_id\": {{integer}},\n\t\"unit_id\": {{integer}}\n}"},"url":"{{public_api_url}}compliance-stream/detach","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["detach"],"host":["{{public_api_url}}compliance-stream"],"query":[],"variable":[]}},"response":[],"_postman_id":"72f677f8-25a7-42ab-84cf-8944dc81522a"}],"id":"8fc84a66-ca27-474b-ae56-ea31f2c67cd4","_postman_id":"8fc84a66-ca27-474b-ae56-ea31f2c67cd4","description":""},{"name":"Document","item":[{"name":"Post a PDF to the Load Queue","id":"15b4756a-3473-4489-8edc-be7752441583","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"document","type":"file","src":"/Users/graemekilkenny/Desktop/Working/Met/Original/Elec Cert Examples 2/37160160_16 Sellars Avenue_Ruddington_2020-01-15_Electrical Certificate_....pdf"}]},"url":"{{public_api_url}}pdf","description":"File size upload limit 1Mb
\n\nRequires: This endpoint requires an API role of API Client or API Contractor
\n
\n","urlObject":{"host":["{{public_api_url}}pdf"],"query":[],"variable":[]}},"response":[{"id":"511d71e1-9d9b-4db3-9a05-bac25bda02b8","name":"Post a PDF to the Load Queue","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"document","type":"file","value":null}]},"url":"{{public_api_url}}pdf"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.8"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.2.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 03 Jul 2020 10:46:41 GMT"},{"key":"X-RateLimit-Limit","value":"1000"},{"key":"X-RateLimit-Remaining","value":"997"},{"key":"Set-Cookie","value":"true_compliance_session=adRZKwo8i2ALYGwvT627riXi4yVMwpoVVNZ4caNA; expires=Fri, 03-Jul-2020 12:46:41 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"filename\": \"example-supporting-document.pdf\",\n \"extracted_data\": null,\n \"loaded_by_user\": {\n \"id\": \"\",\n \"email\": \"sample.user@example.com\",\n \"avatar\": \"https://example.com/avatars/user-placeholder.png\",\n \"first_name\": \"Sample\",\n \"last_name\": \"Resident\"\n },\n \"loaded_on\": \"2025-03-11 15:49:02\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"EXAMPLE_STATUS\",\n \"description\": \"Dummy status description for documentation only.\",\n \"directory\": null\n },\n \"certificate_instance\": [],\n \"document_type\": {\n \"id\": \"\",\n \"name\": \"EXAMPLE_DOCUMENT_TYPE\",\n \"slug\": \"example_document_type\"\n },\n \"url\": \"https://example.com/example-supporting-document.pdf\",\n \"certificate_id\": null\n}"}],"_postman_id":"15b4756a-3473-4489-8edc-be7752441583"},{"name":"Get Current Load Queue","id":"e8fb2726-2117-4b18-92a4-13d39616ec8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{public_api_url}}document/loading","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["loading"],"host":["{{public_api_url}}document"],"query":[],"variable":[]}},"response":[{"id":"4fa62504-d8a8-4446-a524-7dfe676db3bf","name":"Get Current Load Queue","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{public_api_url}}document/loading"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"total\": 13,\n \"jobs\": [\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"PROCESSING\",\n \"description\": \"This document is being processed (dummy status for documentation only).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Fire Risk Assessment - Sample Site A (SITEA0001).pdf\",\n \"loaded_on\": \"2025-01-15 09:12:34\",\n \"updated_at\": \"2025-01-15 09:45:10\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"EXTRACTING\",\n \"description\": \"This document is running through the extraction process (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Certificate Pack - Building B (BLDGB0002).pdf\",\n \"loaded_on\": \"2025-01-16 14:03:22\",\n \"updated_at\": \"2025-01-16 14:05:01\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"EXTRACTING\",\n \"description\": \"This document is running through the extraction process (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Inspection Report - Site C (SITEC0003).pdf\",\n \"loaded_on\": \"2025-01-17 08:30:00\",\n \"updated_at\": \"2025-01-17 08:42:19\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"INSERTING\",\n \"description\": \"Extracted data is being inserted into the system (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Fire Risk Assessment - Sample Site D (SITED0004).pdf\",\n \"loaded_on\": \"2025-01-18 11:47:11\",\n \"updated_at\": \"2025-01-19 10:15:33\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"INSERTING\",\n \"description\": \"Extracted data is being inserted into the system (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Fire Risk Assessment - Sample Site E (SITEE0005).pdf\",\n \"loaded_on\": \"2025-01-18 15:03:14\",\n \"updated_at\": \"2025-01-18 16:56:40\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"INSERTING\",\n \"description\": \"Extracted data is being inserted into the system (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Fire Risk Assessment - Sample Site F (SITEF0006).pdf\",\n \"loaded_on\": \"2025-01-19 18:38:23\",\n \"updated_at\": \"2025-01-19 18:53:57\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"INSERTING\",\n \"description\": \"Extracted data is being inserted into the system (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Fire Risk Assessment - Sample Site G (SITEG0007).pdf\",\n \"loaded_on\": \"2025-01-20 13:07:01\",\n \"updated_at\": \"2025-01-20 13:21:14\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"INSERTING\",\n \"description\": \"Extracted data is being inserted into the system (dummy text).\",\n \"directory\": null\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Fire Risk Assessment - Sample Site H (SITEH0008).pdf\",\n \"loaded_on\": \"2025-01-20 13:13:26\",\n \"updated_at\": \"2025-01-20 13:17:56\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"NEW\",\n \"description\": \"A document that has been added to the queue (dummy text).\",\n \"directory\": \"load-queue\"\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Supporting Document - Site I (SITEI0009).pdf\",\n \"loaded_on\": \"2025-01-21 11:25:46\",\n \"updated_at\": \"2025-01-21 11:25:46\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"NEW\",\n \"description\": \"A document that has been added to the queue (dummy text).\",\n \"directory\": \"load-queue\"\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Phase Report - Site J (SITEJ0010).pdf\",\n \"loaded_on\": \"2025-01-22 13:18:05\",\n \"updated_at\": \"2025-01-22 13:18:05\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"NEW\",\n \"description\": \"A document that has been added to the queue (dummy text).\",\n \"directory\": \"load-queue\"\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Phase Report - Site J (SITEJ0011).pdf\",\n \"loaded_on\": \"2025-01-22 13:19:42\",\n \"updated_at\": \"2025-01-22 13:19:42\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"NEW\",\n \"description\": \"A document that has been added to the queue (dummy text).\",\n \"directory\": \"load-queue\"\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Phase Report - Site J (SITEJ0012).pdf\",\n \"loaded_on\": \"2025-01-22 14:31:19\",\n \"updated_at\": \"2025-01-22 14:31:19\"\n },\n {\n \"id\": \"\",\n \"document_type_id\": \"\",\n \"document_status_id\": \"\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"NEW\",\n \"description\": \"A document that has been added to the queue (dummy text).\",\n \"directory\": \"load-queue\"\n },\n \"loaded_by\": \"Sample Resident\",\n \"filename\": \"Example Phase Report - Site J (SITEJ0013).pdf\",\n \"loaded_on\": \"2025-01-22 14:32:48\",\n \"updated_at\": \"2025-01-22 14:32:48\"\n }\n ]\n}"}],"_postman_id":"e8fb2726-2117-4b18-92a4-13d39616ec8e"},{"name":"Get Document","id":"2d6a6178-ecbf-471d-93dc-cdd10c3c61b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}document/{{document_id}}","urlObject":{"path":["{{document_id}}"],"host":["{{public_api_url}}document"],"query":[],"variable":[]}},"response":[{"id":"929ef34a-29b8-4ef8-9717-d1d6eec2c78b","name":"Get Document","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}document/{{document_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"id\": \"\",\n \"filename\": \"example-fire-risk-assessment-site-a.pdf\",\n \"extracted_data\": null,\n \"loaded_by_user\": {\n \"id\": \"\",\n \"email\": \"broody@example.com\",\n \"avatar\": \"https://example.com/avatars/user-placeholder.png\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Broody\"\n },\n \"loaded_on\": \"2025-03-11 11:53:37\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"LOADED_SUCCESSFULLY\",\n \"description\": \"This document was successfully loaded (dummy response for documentation only).\",\n \"directory\": null\n },\n \"certificate_instance\": [],\n \"document_type\": {\n \"id\": \"\",\n \"name\": \"UPLOADED\",\n \"slug\": null\n },\n \"url\": \"https://example.com/example-fire-risk-assessment-site-a.pdf\",\n \"certificate_id\": \"\"\n }\n}"}],"_postman_id":"2d6a6178-ecbf-471d-93dc-cdd10c3c61b4"},{"name":"Get an authenticated upload URL","event":[{"listen":"test","script":{"id":"ab3b382f-4157-49a8-87f2-65e1a3f1af2b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"s3_upload_url\", jsonData.data.url);"],"type":"text/javascript"}}],"id":"159c69b9-499c-4aea-a341-519941ed79c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"filename\": \"May2020-LGSR.pdf\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}pdf/upload-url","description":"Register your document with us, and receive a temporary authenticated upload url to which you can send your PDF. Simply POST the filename of your PDF to this endpoint.
\n\nRequires: This endpoint requires an API role of API Client or API Contractor
\n
\n","urlObject":{"path":["upload-url"],"host":["{{public_api_url}}pdf"],"query":[],"variable":[]}},"response":[{"id":"85abf2d1-39b2-4e16-b4bb-099f6e6c58de","name":"Get an authenticated upload URL","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"filename\": \"May2020-LGSR.pdf\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}pdf/upload-url"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"document_id\": 123456,\n \"url\": \"https://example.com/docs/May2020-LGSR.pdf\"\n }\n}"}],"_postman_id":"159c69b9-499c-4aea-a341-519941ed79c5"},{"name":"Upload Supporting Document","event":[{"listen":"test","script":{"id":"ab3b382f-4157-49a8-87f2-65e1a3f1af2b","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"s3_upload_url\", jsonData.data.url);"],"type":"text/javascript","packages":{}}}],"id":"53116cc2-fff7-480b-84e5-071ea1cf78a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"document","description":"File to upload as supporting document
\n","type":"file","value":null},{"key":"document_title","value":"Supporting File Name","type":"text"},{"key":"property_id","value":"{{integer}}","type":"text"},{"key":"compliance_stream_id","value":"{{integer}}","type":"text"},{"key":"folder","value":"Supporting Folder/sub folder","description":"Not required, we can add sub folders
\n","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}]},"url":"{{public_api_url}}document/supporting-document","description":"\nRequires: This endpoint requires an API role of API Client or API Contractor
\n
\n","urlObject":{"path":["supporting-document"],"host":["{{public_api_url}}document"],"query":[],"variable":[]}},"response":[{"id":"0d227ec3-19e1-47c5-b6bf-226b0412bf81","name":"Upload Supporting Document","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"document","description":"File to upload as supporting document","type":"file","value":null},{"key":"document_title","value":"Supporting File Name","type":"text"},{"key":"property_id","value":"{{integer}}","type":"text"},{"key":"compliance_stream_id","value":"{{integer}}","type":"text"},{"key":"folder","value":"Supporting Folder/sub folder","description":"Not required, we can add sub folders","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}]},"url":"{{public_api_url}}document/supporting-document"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"\",\n \"filename\": \"example-supporting-document-002.pdf\",\n \"extracted_data\": null,\n \"loaded_by_user\": {\n \"id\": \"\",\n \"email\": \"tim.brooch@example.com\",\n \"avatar\": \"https://example.com/avatars/user-placeholder.png\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Brooch\"\n },\n \"loaded_on\": \"2025-03-11 16:14:19\",\n \"document_status\": {\n \"id\": \"\",\n \"name\": \"STORAGE_ONLY\",\n \"description\": \"This document is stored only (dummy response for documentation).\",\n \"directory\": null\n },\n \"certificate_instance\": [],\n \"document_type\": {\n \"id\": \"\",\n \"name\": \"EXAMPLE_ADDITIONAL_PROPERTY_DOCUMENT\",\n \"slug\": \"example_additional_property_document\"\n },\n \"url\": \"https://example.com/example-supporting-document-002.pdf\",\n \"certificate_id\": null\n}"}],"_postman_id":"53116cc2-fff7-480b-84e5-071ea1cf78a5"},{"name":"Use upload URL to send PDF","id":"5c82f097-eaee-405d-92c6-cffaec45cca1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/graemekilkenny/Desktop/6-main-road.pdf"}]},"url":"{{s3_upload_url}}","description":"Use the URL obtained from \"Get an authenticated upload URL\" to send your PDF to our storage area
\n","urlObject":{"host":["{{s3_upload_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c82f097-eaee-405d-92c6-cffaec45cca1"}],"id":"abdf5cac-1d50-4197-9240-0577b770e9e0","_postman_id":"abdf5cac-1d50-4197-9240-0577b770e9e0","description":""},{"name":"Fault","item":[{"name":"Update Status","id":"4a59c8a9-4cfd-4235-9807-e02960d111be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fault_status\": \"{{the-required-fault-status}}\"\n}"},"url":"{{public_api_url}}fault/{{fault_id}}/update-status","description":"You can amend the status of any fault by using this endpoint.
\nRetrieve the fault ID from the Asset or Certificate it is attached to, and then call this endpoint with the desired status in the body parameters.
\nValid fault statuses are as follows:
\n\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{fault_id}}","update-status"],"host":["{{public_api_url}}fault"],"query":[],"variable":[]}},"response":[{"id":"1a434072-a828-437d-8c4b-4adc1560cb50","name":"Update Status","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fault_status\": \"{{the-required-fault-status}}\"\n}"},"url":"{{public_api_url}}fault/{{fault_id}}/update-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Fault updated\",\n \"data\": {\n \"message\": \"Example fault message for documentation purposes.\",\n \"corrective_action\": \"Example corrective action text for documentation purposes.\",\n \"superceded\": true,\n \"fault_status\": \"remedial\",\n \"is_fault_non_compliant\": false,\n \"reviewed\": true,\n \"parent_type\": \"Certificate\",\n \"parent_id\": \"\",\n \"test\": {\n \"name\": \"Example Test Name\",\n \"description\": \"Example test description for documentation purposes.\"\n }\n }\n}"}],"_postman_id":"4a59c8a9-4cfd-4235-9807-e02960d111be"},{"name":"Add a Note to a Fault","id":"30cc90c1-4b25-4cb6-89f2-122132980aa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"note","value":"This is my note to add","type":"text","description":"String
\n"},{"key":"evidence","description":"File. Optional. 1mb max filesize.
\n","type":"file","value":null}]},"url":"{{public_api_url}}fault/{{fault_id}}/note","description":"Will add a note to a fault, with optional attachment.
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{fault_id}}","note"],"host":["{{public_api_url}}fault"],"query":[],"variable":[]}},"response":[{"id":"2acb182b-c31a-4be6-a87d-a9e201f368e2","name":"Add a Note to a Fault","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"note","value":"This is my note to add","type":"text","description":"String"},{"key":"evidence","description":"File. Optional. 1mb max filesize.","type":"file","value":null}]},"url":"{{public_api_url}}fault/{{fault_id}}/note"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Note added\",\n \"data\": {\n \"id\": \"\",\n \"requires_action\": 0,\n \"type\": \"Example Action Type\",\n \"status\": \"Rejected\",\n \"deadline\": \"2026-12-31\",\n \"owner\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n },\n \"team\": \"Example Team Alpha\",\n \"values\": {\n \"Question\": \"Example question text for documentation purposes.\",\n \"Question Answer\": \"Example answer\",\n \"Required Action\": \"Example required action text for documentation purposes.\",\n \"Action By\": \"\",\n \"Priority\": \"B\",\n \"Action Photo\": \"\",\n \"Question Comments\": \"\",\n \"Action No.\": \"\",\n \"Action Location\": \"\",\n \"Action Category\": \"Example Category: Maintenance\"\n },\n \"approved_at\": \"2026-03-11 14:56:47\",\n \"approved_by\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n },\n \"completed_at\": \"2026-03-11 14:56:47\",\n \"completed_by\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n },\n \"compliance_statuses\": [\n {\n \"type\": \"Example Compliance Check A\",\n \"compliant\": false\n },\n {\n \"type\": \"Example Compliance Check B\",\n \"compliant\": false\n },\n {\n \"type\": \"Example Compliance Check C\",\n \"compliant\": false\n },\n {\n \"type\": \"Example Compliance Check D\",\n \"compliant\": false\n },\n {\n \"type\": \"Example Compliance Check E\",\n \"compliant\": false\n },\n {\n \"type\": \"Example Compliance Check F\",\n \"compliant\": false\n },\n {\n \"type\": \"Example Compliance Check G\",\n \"compliant\": false\n }\n ],\n \"certificate\": {\n \"id\": \"\",\n \"document_id\": \"\",\n \"issue_date\": \"2025-02-01\",\n \"certificate_number\": \"\",\n \"certificate_instance\": \"Example Platform v1\",\n \"certificate_type\": \"FRA\",\n \"contractor\": \"Example Contractor Ltd\"\n },\n \"unit\": {\n \"uprn\": \"\",\n \"unit_id\": \"\",\n \"full_address\": \"Example House, Example Street, Example Town, EX1 2AB\"\n },\n \"notes\": [\n {\n \"note\": \"This item was previously closed (dummy note for documentation).\",\n \"created_at\": \"2025-01-10 11:39:29\",\n \"updated_at\": \"2025-01-10 11:39:29\",\n \"created_by\": {\n \"name\": \"Example System\",\n \"email\": \"system@example.com\"\n },\n \"attachments\": [],\n \"tags\": []\n },\n {\n \"note\": \"This is my note to add\",\n \"created_at\": \"2026-03-11 14:51:12\",\n \"updated_at\": \"2026-03-11 14:51:12\",\n \"created_by\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n },\n \"attachments\": [],\n \"tags\": []\n },\n {\n \"note\": \"Example completion note (dummy).\",\n \"created_at\": \"2026-03-11 14:56:47\",\n \"updated_at\": \"2026-03-11 14:56:47\",\n \"created_by\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n },\n \"attachments\": [],\n \"tags\": []\n },\n {\n \"note\": \"This is my note to add\",\n \"created_at\": \"2026-03-11 16:20:54\",\n \"updated_at\": \"2026-03-11 16:20:54\",\n \"created_by\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n },\n \"attachments\": [],\n \"tags\": []\n }\n ],\n \"photos\": [],\n \"flags\": [],\n \"logs\": [\n {\n \"message\": \"Action status was updated to Rejected.\",\n \"logged_at\": \"15:01pm 11th Mar 2026\",\n \"user\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n }\n },\n {\n \"message\": \"Action was assigned to Alex Broody and assigned to Example Team Alpha.\",\n \"logged_at\": \"15:00pm 11th Mar 2026\",\n \"user\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n }\n },\n {\n \"message\": \"Action was marked as closed.\",\n \"logged_at\": \"14:56pm 11th Mar 2026\",\n \"user\": {\n \"name\": \"Alex Broody\",\n \"email\": \"broody@example.com\"\n }\n },\n {\n \"message\": \"\",\n \"logged_at\": \"17:22pm 2nd Oct 2023\",\n \"user\": {\n \"name\": \"Example System\",\n \"email\": \"system@example.com\"\n }\n }\n ]\n }\n}"}],"_postman_id":"30cc90c1-4b25-4cb6-89f2-122132980aa4"}],"id":"a2a36dbb-0224-43e9-b842-2a31d4c51e79","_postman_id":"a2a36dbb-0224-43e9-b842-2a31d4c51e79","description":""},{"name":"Flags","item":[{"name":"Manage flags for a model","id":"7d8cd6ac-b56a-4bd0-86a3-b3f092c736ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"flag_name\": \"Example flag name\",\n \"model_type\": \"unit\",\n \"model_id\": 12345,\n \"action\": \"remove\", // add - remove\n \"expiry_date\": \"2024-03-02\" // Date Y-m-d\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}flag/manage","description":"Description: Adds or removes flags for a model.
\nRequest Parameters:
\n\nmodel_type: unit, certificate, action
\nflag_name: A flag name that exist on a organisation
\naction: add, remove.
\nmodel_id: Model id to add or remove
\nexpiry_date: Optional: If the flag being assigned to a model has Items Expire enabled, the expiry_date parameter will be added to the flag.
\n
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["manage"],"host":["{{public_api_url}}flag"],"query":[],"variable":[]}},"response":[{"id":"0ab88537-e8b3-4d49-bf0a-178c694da103","name":"Manage flags for a model","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"flag_name\": \"Example flag name\",\n \"model_type\": \"unit\",\n \"model_id\": 12345,\n \"action\": \"remove\", // add - remove\n \"expiry_date\": \"2024-03-02\" // Date Y-m-d\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_url}}flag/manage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Action: remove flag to unit was successful\",\n \"data\": []\n}"}],"_postman_id":"7d8cd6ac-b56a-4bd0-86a3-b3f092c736ef"}],"id":"41fb33c6-dd00-4cd1-82a0-db7adb0a1be9","_postman_id":"41fb33c6-dd00-4cd1-82a0-db7adb0a1be9","description":""},{"name":"Material","item":[{"name":"Get a Material","id":"7e6b8062-31a9-4577-bb86-9e75eee1954d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}material/{{material_id}}","description":"Get a material object
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{material_id}}"],"host":["{{public_api_url}}material"],"query":[],"variable":[]}},"response":[{"id":"4a40dbf7-a5f8-47e8-8cb6-a80407fb1f02","name":"Get a Material","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}material/{{material_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"id\": \"\",\n \"unit_id\": \"\",\n \"material_number\": \"\",\n \"location\": \"Example Location / Example Room\",\n \"next_due_date\": \"2026-12-31\",\n \"sitemap_coordinates\": null,\n \"compliance_stream\": \"Example Safety Stream\",\n \"material_type\": \"Example Material Type\",\n \"material_status\": \"EXAMPLE_STATUS\",\n \"samples\": [\n {\n \"id\": \"\",\n \"sample_number\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"contractor_id\": \"\",\n \"issue_date\": \"2026-01-15\",\n \"compliance_stream_id\": \"\",\n \"created_at\": \"2026-01-16 10:00:00\",\n \"certificate_number\": \"\",\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example-certificate-document.pdf\",\n \"loaded_by\": \"\",\n \"loaded_on\": \"2026-01-16 09:58:00\",\n \"url\": \"https://example.com/documents/example-certificate-document.pdf\"\n },\n \"actions\": [],\n \"compliance_statuses\": [\n {\n \"compliance_stream\": \"Example Safety Stream\",\n \"compliance_type\": \"Example Compliance Type A\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": null,\n \"next_due_date\": null,\n \"updated_at\": \"2026-02-01 12:00:00\"\n },\n {\n \"compliance_stream\": \"Example Safety Stream\",\n \"compliance_type\": \"Example Compliance Type B\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": null,\n \"next_due_date\": null,\n \"updated_at\": \"2026-02-01 12:00:00\"\n }\n ]\n }\n ],\n \"values\": {\n \"Survey Level\": \"Example Survey Level\",\n \"Location\": \"Example Location / Example Room\",\n \"Number of Occupants\": \"Example Value\",\n \"Description\": \"Example material description for documentation purposes.\",\n \"Approx Extent of Material\": \"Example extent (e.g., 4m2)\",\n \"Condition\": \"Example condition\",\n \"Damage/deterioration\": \"Example damage notes\",\n \"Vulnerability\": \"Example vulnerability notes\",\n \"Sample No/Asbestos Type\": \"Example sample info / Example result text\",\n \"Total Score\": \"Example score\",\n \"Risk\": \"Example risk rating\",\n \"Asbestos Type\": \"Example classification\",\n \"Sample Number\": \"\",\n \"Recommendation\": \"Example recommendation text for documentation purposes.\"\n },\n \"logs\": []\n }\n}"}],"_postman_id":"7e6b8062-31a9-4577-bb86-9e75eee1954d"},{"name":"Update a Material","id":"547b21aa-54b4-40b4-a4d4-c048f45d413a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"unit_id\": 123456,\n\t\"material_number\": \"EXAMPLE-MATERIAL-00001\",\n\t\"location\": \"Kitchen\",\n\t\"next_due_date\": \"2027-01-01\",\n\t\"sitemap_coordinates\": null,\n\t\"compliance_stream\": \"Asbestos\",\n\t\"material_type\": \"Chrysotile\",\n\t\"material_status\": \"ACTIVE\"\n}"},"url":"{{public_api_url}}material/{{material_id}}","description":"Update a material object
\nValid options for the material_status field are:
\nACTIVE
\nNOT_FOUND
\nREMOVED
\n\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{material_id}}"],"host":["{{public_api_url}}material"],"query":[],"variable":[]}},"response":[{"id":"c6e7bc68-bb03-46ee-85aa-1240cb5887c1","name":"Update a Material","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"unit_id\": 123456,\n\t\"material_number\": \"EXAMPLE-MATERIAL-00001\",\n\t\"location\": \"Kitchen\",\n\t\"next_due_date\": \"2027-01-01\",\n\t\"sitemap_coordinates\": null,\n\t\"compliance_stream\": \"Asbestos\",\n\t\"material_type\": \"Chrysotile\",\n\t\"material_status\": \"ACTIVE\"\n}"},"url":"{{public_api_url}}material/{{material_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Material updated\",\n \"data\": {\n \"id\": \"\",\n \"unit_id\": \"\",\n \"material_number\": \"\",\n \"location\": \"Example Location (e.g., Kitchen)\",\n \"next_due_date\": \"2027-01-01\",\n \"sitemap_coordinates\": \"00.000000, 00.000000\",\n \"compliance_stream\": \"Example Safety Stream\",\n \"material_type\": \"Example Material Type\",\n \"material_status\": \"EXAMPLE_STATUS\",\n \"samples\": [\n {\n \"id\": \"\",\n \"sample_number\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"contractor_id\": \"\",\n \"issue_date\": \"2026-01-15\",\n \"compliance_stream_id\": \"\",\n \"created_at\": \"2026-01-16 10:00:00\",\n \"certificate_number\": \"\",\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example-certificate-document.pdf\",\n \"loaded_by\": \"\",\n \"loaded_on\": \"2026-01-16 09:58:00\",\n \"url\": \"https://example.com/documents/\"\n },\n \"actions\": [],\n \"compliance_statuses\": [\n {\n \"compliance_stream\": \"Example Safety Stream\",\n \"compliance_type\": \"Example Compliance Type A\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": null,\n \"next_due_date\": null,\n \"updated_at\": \"2026-02-01 12:00:00\"\n },\n {\n \"compliance_stream\": \"Example Safety Stream\",\n \"compliance_type\": \"Example Compliance Type B\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": null,\n \"next_due_date\": null,\n \"updated_at\": \"2026-02-01 12:00:00\"\n }\n ]\n }\n ],\n \"values\": {\n \"Survey Level\": \"Example Survey Level\",\n \"Location\": \"Example Location (e.g., Ground Floor / Bathroom)\",\n \"Number of Occupants\": \"Example Value\",\n \"Description\": \"Example material description for documentation purposes.\",\n \"Approx Extent of Material\": \"Example extent (e.g., 4m2)\",\n \"Condition\": \"Example condition\",\n \"Damage/deterioration\": \"Example damage notes\",\n \"Vulnerability\": \"Example vulnerability notes\",\n \"Sample No/Asbestos Type\": \"Example sample info / Example result text\",\n \"Total Score\": \"Example score\",\n \"Risk\": \"Example risk rating\",\n \"Asbestos Type\": \"Example classification\",\n \"Sample Number\": \"\",\n \"Recommendation\": \"Example recommendation text for documentation purposes.\"\n },\n \"logs\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"model_id\": \"\",\n \"model_type\": \"\",\n \"message\": \"Example log message: This material was updated.\",\n \"created_at\": \"2026-03-12 12:38:48\",\n \"formatted_time\": \"12:38pm\",\n \"formatted_date\": \"12th Mar 2026\",\n \"user\": {\n \"id\": \"\",\n \"email\": \"broody@example.com\",\n \"email_verified_at\": null,\n \"slug\": \"alex-broody\",\n \"avatar\": \"https://example.com/avatars/user-placeholder.png\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Broody\",\n \"is_deleted\": false\n }\n }\n ]\n }\n}"}],"_postman_id":"547b21aa-54b4-40b4-a4d4-c048f45d413a"}],"id":"e2b3ef93-73b9-402a-9ea1-043fdca51ecd","_postman_id":"e2b3ef93-73b9-402a-9ea1-043fdca51ecd","description":""},{"name":"Report","item":[{"name":"Get the latest copy of this Report","id":"1e55f04d-a629-4d21-b76c-8f51f0ec2cf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}report/{{report-name}}","description":"\nRequires: This endpoint requires an API role of API Client or API Contractor.
Return type: Json
- If the data is more than 1 MB then we will return the link to the JSON file.
- The link to the json file is valid for 20 mins.
\n
\n","urlObject":{"path":["{{report-name}}"],"host":["{{public_api_url}}report"],"query":[],"variable":[]}},"response":[{"id":"03d3a207-ab6c-4991-8b0b-fdc8e87a5079","name":"When the report is more than 1MB","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}report/{{report-name}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Report data retrieved.\",\n \"data\": {\n \"download_link\": \"https://example.com/report_download_link\",\n \"error\": \"Report data too large, please use download link.\"\n }\n}"},{"id":"ba97071f-4059-41d5-9820-cd813012a8f4","name":"When the report is less than 1MB","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}report/{{report-name}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Report data retrieved.\",\n \"data\": {\n \"download_link\": \"https://example.com/report-download-link\",\n \"properties-loaded\": [\n {\n \"uprn\": \"\",\n \"address\": \"Flat A, 10 Example Street, London, , , , EX1 2AB\",\n \"postcode\": \"EX1 2AB\",\n \"tenure\": \"Example Tenure Type\",\n \"certificate_id\": \"\",\n \"doccument_id\": \"\",\n \"name\": \"LOADED_SUCCESSFULLY\",\n \"certificate_number\": \"\",\n \"contractor\": \"Example Contractor Ltd\",\n \"filename\": \"example-certificate-1.pdf\",\n \"issue date\": \"11/03/2026\",\n \"loaded date\": \"11/03/2026 13:19\",\n \"loaded_by\": \"Example Service Team\"\n },\n {\n \"uprn\": \"\",\n \"address\": \"Flat B, 20 Sample Road, London, , , , EX3 4CD\",\n \"postcode\": \"EX3 4CD\",\n \"tenure\": \"Example Tenure Type\",\n \"certificate_id\": \"\",\n \"doccument_id\": \"\",\n \"name\": \"LOADED_SUCCESSFULLY\",\n \"certificate_number\": \"\",\n \"contractor\": \"Example Contractor Ltd\",\n \"filename\": \"example-certificate-2.pdf\",\n \"issue date\": \"10/03/2026\",\n \"loaded date\": \"11/03/2026 12:19\",\n \"loaded_by\": \"Example Service Team\"\n }\n ],\n \"documents-unsucessful\": [],\n \"certificates-rejected\": [\n {\n \"UPRN\": \"\",\n \"Address\": \"Flat C, 30 Demo Crescent, London, , , , EX5 6EF\",\n \"Postcode\": \"EX5 6EF\",\n \"Tenure\": \"Example Tenure Type\",\n \"Certificate Number\": \"\",\n \"Certificate Type\": \"Example Certificate Type\",\n \"compliant\": \"Non-compliant\",\n \"issue_date\": \"2026-01-19\",\n \"message\": \"Example rejection message for documentation purposes.\",\n \"corrective_action\": \"Example corrective action text.\",\n \"Rejection_created_at\": \"2026-01-22 17:20:37\",\n \"AR/ID\": \"No\"\n }\n ],\n \"properties-jeopardy\": [\n {\n \"uprn\": \"\",\n \"address\": \"Flat 2, 40 Example Lane, London, , , , EX7 8GH\",\n \"tenure\": \"Example Tenure Type\",\n \"last_checked_date\": \"2025-04-17\",\n \"next_due_date\": \"2026-04-23\",\n \"days\": 42\n },\n {\n \"uprn\": \"\",\n \"address\": \"Flat 5, 50 Sample House, Demo Street, London, , , EX9 1JK\",\n \"tenure\": \"Example Tenure Type\",\n \"last_checked_date\": \"2025-03-21\",\n \"next_due_date\": \"2026-04-20\",\n \"days\": 39\n },\n {\n \"uprn\": \"\",\n \"address\": \"Block A, Example Building, 60 Test Road, London, , EX2 3LM\",\n \"tenure\": \"Example Block Tenure\",\n \"last_checked_date\": \"2024-10-30\",\n \"next_due_date\": \"2025-10-30\",\n \"days\": -133\n }\n ]\n }\n}"}],"_postman_id":"1e55f04d-a629-4d21-b76c-8f51f0ec2cf0"}],"id":"776df3c4-4655-4293-bc85-2d35ded07250","_postman_id":"776df3c4-4655-4293-bc85-2d35ded07250","description":""},{"name":"Unit","item":[{"name":"Get Paginated Units","id":"ac10fbb5-753c-4ec4-8a07-ab3b28bf26e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}unit","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"host":["{{public_api_url}}unit"],"query":[{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"created_since","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"created_before","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"updated_since","value":""},{"disabled":true,"description":{"content":"Optional. Date format : Y-m-d. Example : 2021-01-31
\n","type":"text/plain"},"key":"updated_before","value":""},{"disabled":true,"description":{"content":"Optional. Integer. Default: 1. The page number of the results to fetch.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Optional. Integer. Default: 15. The number of results per page.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Optional. Boolean. Default: false. Return a more limited data set.
\n","type":"text/plain"},"key":"shallow","value":""}],"variable":[]}},"response":[{"id":"08ffa970-7de0-4ef0-8d22-ac605db67257","name":"Get Paginated Units","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{public_api_url}}unit","host":["{{public_api_url}}unit"],"query":[{"key":"created_since","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"created_before","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"updated_since","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"updated_before","value":"","description":"Optional. Date format : Y-m-d. Example : 2021-01-31","disabled":true},{"key":"page","value":"","description":"Optional. Integer. Default: 1. The page number of the results to fetch.","disabled":true},{"key":"limit","value":"","description":"Optional. Integer. Default: 15. The number of results per page.","disabled":true},{"key":"shallow","value":"","description":"Optional. Boolean. Default: false. Return a more limited data set.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": \"\",\n \"uprn\": \"\",\n \"address_1\": \"Unit 1A\",\n \"address_2\": \"Example House\",\n \"town\": \"Example Street\",\n \"county\": \"Example County\",\n \"postcode\": \"EX1 2AB\",\n \"resident\": \"\",\n \"slug\": \"uprn-example-0001-unit-1a-example-house-example-street\",\n \"updated_at\": \"2025-08-22 01:01:11\",\n \"address_string\": \"Unit 1A, Example House, Example Street, Example Town, EX1 2AB\",\n \"property_type\": \"Office\",\n \"parent_property\": {},\n \"child_properties\": [],\n \"organisation\": {\n \"name\": \"Example Organisation\",\n \"two_factor\": null,\n \"logo\": null\n },\n \"property_data\": {\n \"uprn\": \"\",\n \"status\": \"LIVE\",\n \"address_1\": \"Unit 1A\",\n \"address_2\": \"Example House\",\n \"address_3\": \"Example Street\",\n \"address_4\": \"Example Town\",\n \"address_5\": \"NULL\",\n \"postcode\": \"EX1 2AB\",\n \"tenure\": \"OFFICE\",\n \"has_fire\": \"No\",\n \"has_water\": \"No\",\n \"has_gas\": null,\n \"has_elec\": null,\n \"has_loler\": null,\n \"has_playground\": null,\n \"has_aov\": null,\n \"has_fire_alarms\": null,\n \"has_wet_risers\": null,\n \"has_dry_risers\": null,\n \"has_emergency_lighting\": null,\n \"new_this_week\": \"1\",\n \"updated_this_week\": \"1\",\n \"dfdf\": null,\n \"risk_category\": \"Example Category\",\n \"data\": null,\n \"youd_like\": null,\n \"to\": null,\n \"add\": null\n },\n \"certificates\": [\n {\n \"id\": \"\",\n \"issue_date\": \"2025-06-29\",\n \"certificate_number\": \"\",\n \"contractor\": \"Example Contractor Ltd\",\n \"compliance_stream\": \"Gas\",\n \"created_at\": \"2025-06-30 09:15:00\",\n \"updated_at\": \"2025-07-01 10:00:00\",\n \"instance\": {\n \"name\": \"Example Instance A\",\n \"slug\": \"example-instance-a\",\n \"rejection_to_emails\": null,\n \"exclusion_document\": false\n },\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example-cert-1001.pdf\",\n \"url\": \"https://example.com/example-cert-1001.pdf\"\n }\n },\n {\n \"id\": \"\",\n \"issue_date\": \"2025-08-31\",\n \"certificate_number\": \"\",\n \"contractor\": \"Example Contractor Ltd\",\n \"compliance_stream\": \"Electrical\",\n \"created_at\": \"2025-09-01 12:00:00\",\n \"updated_at\": \"2025-09-03 08:30:00\",\n \"instance\": {\n \"name\": \"Example Instance B\",\n \"slug\": \"example-instance-b\",\n \"rejection_to_emails\": null,\n \"exclusion_document\": false\n },\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example-cert-1002.pdf\",\n \"url\": \"https://example.com/example-cert-1002.pdf\"\n }\n }\n ],\n \"assets\": [\n {\n \"id\": \"\",\n \"asset_type_id\": \"\",\n \"property_id\": \"\",\n \"slug\": null\n },\n {\n \"id\": \"\",\n \"asset_type_id\": \"\",\n \"property_id\": \"\",\n \"slug\": null\n }\n ],\n \"compliance_statuses\": [\n {\n \"compliance_stream\": \"Gas\",\n \"compliance_type\": \"Example Compliance Type A\",\n \"compliant\": 0,\n \"non_compliant_reason\": \"Example reason\",\n \"last_checked_date\": \"2025-07-12\",\n \"next_due_date\": \"2026-07-12\",\n \"updated_at\": \"2025-07-13 02:01:05\"\n },\n {\n \"compliance_stream\": \"Gas\",\n \"compliance_type\": \"Example Compliance Type B\",\n \"compliant\": 0,\n \"non_compliant_reason\": \"Example reason\",\n \"last_checked_date\": \"2025-07-12\",\n \"next_due_date\": \"2026-07-12\",\n \"updated_at\": \"2025-07-13 02:01:05\"\n },\n {\n \"compliance_stream\": \"Electrical\",\n \"compliance_type\": \"Example Compliance Type C\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": \"2025-08-31\",\n \"next_due_date\": \"2026-08-31\",\n \"updated_at\": \"2025-09-01 02:01:05\"\n }\n ],\n \"compliance_streams\": [\n {\n \"name\": \"Gas\",\n \"last_certificate_id\": \"\"\n },\n {\n \"name\": \"Electrical\",\n \"last_certificate_id\": \"\"\n },\n {\n \"name\": \"Energy Performance Certificate\",\n \"last_certificate_id\": null\n }\n ],\n \"flags\": [],\n \"logs\": []\n },\n {\n \"id\": \"\",\n \"uprn\": \"\",\n \"address_1\": \"Flat 2B\",\n \"address_2\": \"Example Court\",\n \"town\": \"Sample Avenue\",\n \"county\": \"Example County\",\n \"postcode\": \"EX2 3CD\",\n \"resident\": \"\",\n \"slug\": \"uprn-example-0002-flat-2b-example-court-sample-avenue\",\n \"updated_at\": \"2025-10-11 16:09:59\",\n \"address_string\": \"Flat 2B, Example Court, Sample Avenue, Example Town, EX2 3CD\",\n \"property_type\": \"Residence\",\n \"parent_property\": {},\n \"child_properties\": [],\n \"organisation\": {\n \"name\": \"Example Organisation\",\n \"two_factor\": null,\n \"logo\": null\n },\n \"property_data\": {\n \"uprn\": \"\",\n \"status\": null,\n \"address_1\": \"Flat 2B\",\n \"address_2\": \"Example Court\",\n \"address_3\": \"Sample Avenue\",\n \"address_4\": \"Example Town\",\n \"address_5\": null,\n \"postcode\": \"EX2 3CD\",\n \"tenure\": \"RESIDENTIAL\",\n \"has_fire\": null,\n \"has_water\": null,\n \"has_gas\": null,\n \"has_elec\": null,\n \"has_loler\": null,\n \"has_playground\": null,\n \"has_aov\": null,\n \"has_fire_alarms\": null,\n \"has_wet_risers\": null,\n \"has_dry_risers\": null,\n \"has_emergency_lighting\": null,\n \"new_this_week\": \"0\",\n \"updated_this_week\": \"1\",\n \"last_imported_date\": \"2025-11-22\",\n \"dfdf\": null\n },\n \"certificates\": [],\n \"assets\": [],\n \"compliance_statuses\": [],\n \"compliance_streams\": [],\n \"flags\": [],\n \"logs\": []\n }\n ],\n \"first_page_url\": \"{{public_domain}}unit?page=1\",\n \"from\": 1,\n \"last_page\": 4,\n \"last_page_url\": \"{{public_domain}}unit?page=4\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}unit?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"{{public_domain}}unit?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}unit?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}unit?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"{{public_domain}}unit?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"{{public_domain}}unit?page=2\",\n \"path\": \"{{public_domain}}unit\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 15,\n \"total\": 52\n }\n}"}],"_postman_id":"ac10fbb5-753c-4ec4-8a07-ab3b28bf26e4"},{"name":"Get a Unit","id":"fc3a6beb-e42b-4612-a400-8fda02250b82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}unit/{{unit_id}}","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"path":["{{unit_id}}"],"host":["{{public_api_url}}unit"],"query":[],"variable":[]}},"response":[{"id":"2ea60917-1227-44c8-8e5b-683c6b45f90f","name":"Get a Unit","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{public_api_url}}unit/{{unit_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Success\",\n \"data\": {\n \"id\": \"\",\n \"uprn\": \"\",\n \"address_1\": \"UNIT 12B\",\n \"address_2\": \"SAMPLE HOUSE\",\n \"town\": \"SAMPLETON\",\n \"county\": \"SAMPLESHIRE\",\n \"postcode\": \"AB1 2CD\",\n \"resident\": \"Sample Resident\",\n \"slug\": \"999001-unit-12b-sample-house-sampleton\",\n \"updated_at\": \"2026-01-15 09:30:00\",\n \"address_string\": \"UNIT 12B, SAMPLE HOUSE, SAMPLETOWN, AB1 2CD\",\n \"property_type\": \"Residence\",\n \"parent_property\": {},\n \"child_properties\": [],\n \"organisation\": {\n \"name\": \"Example Housing Group\",\n \"two_factor\": null,\n \"logo\": null\n },\n \"property_data\": [],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issue_date\": \"2024-03-01\",\n \"certificate_number\": \">\",\n \"contractor\": \"Example Contractor Ltd\",\n \"compliance_stream\": \"Stream Alpha\",\n \"created_at\": \"2024-03-02 10:00:00\",\n \"updated_at\": \"2026-01-15 09:29:59\",\n \"instance\": {\n \"name\": \"Example Template A\",\n \"slug\": \"example-template-a\",\n \"rejection_to_emails\": null,\n \"exclusion_document\": false\n },\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example_document_a.pdf\",\n \"url\": \"https://example.com/documents/example_document_a.pdf\"\n }\n },\n {\n \"id\": \"\",\n \"issue_date\": \"2025-07-10\",\n \"certificate_number\": \"\",\n \"contractor\": \"Example Services Co\",\n \"compliance_stream\": \"Stream Beta\",\n \"created_at\": \"2025-07-11 11:15:00\",\n \"updated_at\": \"2026-01-15 09:30:00\",\n \"instance\": {\n \"name\": \"Example Template B\",\n \"slug\": \"example-template-b\",\n \"rejection_to_emails\": null,\n \"exclusion_document\": false\n },\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example_document_b.pdf\",\n \"url\": \"https://example.com/documents/example_document_b.pdf\"\n }\n },\n {\n \"id\": \"\",\n \"issue_date\": \"2025-08-25\",\n \"certificate_number\": \"\",\n \"contractor\": \"Example Maintenance Ltd\",\n \"compliance_stream\": \"Stream Gamma\",\n \"created_at\": \"2025-08-25 16:37:00\",\n \"updated_at\": \"2026-01-15 09:29:58\",\n \"instance\": {\n \"name\": \"Example Template C\",\n \"slug\": \"example-template-c\",\n \"rejection_to_emails\": null,\n \"exclusion_document\": false\n },\n \"document\": {\n \"id\": \"\",\n \"filename\": \"example_document_c.pdf\",\n \"url\": \"https://example.com/documents/example_document_c.pdf\"\n }\n }\n ],\n \"assets\": [\n {\n \"id\": \"\",\n \"asset_type_id\": \"\",\n \"property_id\": \"\",\n \"slug\": null\n },\n {\n \"id\": \"\",\n \"asset_type_id\": \"\",\n \"property_id\": \"\",\n \"slug\": null\n },\n {\n \"id\": \"\",\n \"asset_type_id\": \"\",\n \"property_id\": \"\",\n \"slug\": null\n },\n {\n \"id\": \"\",\n \"asset_type_id\": \"\",\n \"property_id\": \"\",\n \"slug\": null\n }\n ],\n \"compliance_statuses\": [\n {\n \"compliance_stream\": \"Stream Alpha\",\n \"compliance_type\": \"Type One\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": \"2025-12-13\",\n \"next_due_date\": \"2030-12-13\",\n \"updated_at\": \"2026-01-15 09:30:00\"\n },\n {\n \"compliance_stream\": \"Stream Beta\",\n \"compliance_type\": \"Type Two\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": \"2025-12-13\",\n \"next_due_date\": \"2030-12-13\",\n \"updated_at\": \"2026-01-15 09:30:00\"\n },\n {\n \"compliance_stream\": \"Stream Gamma\",\n \"compliance_type\": \"Type Three\",\n \"compliant\": 1,\n \"non_compliant_reason\": \"\",\n \"last_checked_date\": \"2025-12-13\",\n \"next_due_date\": \"2030-12-12\",\n \"updated_at\": \"2026-01-15 09:30:00\"\n },\n {\n \"compliance_stream\": \"Stream Delta\",\n \"compliance_type\": \"Type Four\",\n \"compliant\": 0,\n \"non_compliant_reason\": \"Example reason text\",\n \"last_checked_date\": null,\n \"next_due_date\": null,\n \"updated_at\": \"2026-01-15 09:30:00\"\n }\n ],\n \"compliance_streams\": [\n {\n \"name\": \"Stream Alpha\",\n \"last_certificate_id\": \"\"\n },\n {\n \"name\": \"Stream Beta\",\n \"last_certificate_id\": \"\"\n },\n {\n \"name\": \"Stream Gamma\",\n \"last_certificate_id\": \"\"\n }\n ],\n \"flags\": [],\n \"logs\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"model_id\": \"\",\n \"model_type\": \"\",\n \"message\": \"Property was updated\",\n \"created_at\": \"2026-01-15 09:30:00\",\n \"formatted_time\": \"9:30am\",\n \"formatted_date\": \"15th Jan 2026\",\n \"user\": {\n \"id\": \"\",\n \"email\": \"user@example.com\",\n \"email_verified_at\": null,\n \"slug\": \"example-user\",\n \"avatar\": \"https://example.com/avatars/example-user.png\",\n \"first_name\": \"Example\",\n \"last_name\": \"User\",\n \"is_deleted\": false\n }\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"model_id\": \"\",\n \"model_type\": \"\",\n \"message\": \"Property was created\",\n \"created_at\": \"2025-06-01 12:00:00\",\n \"formatted_time\": \"12:00pm\",\n \"formatted_date\": \"1st Jun 2025\",\n \"user\": {\n \"id\": \"\",\n \"email\": \"user@example.com\",\n \"email_verified_at\": null,\n \"slug\": \"example-user\",\n \"avatar\": \"https://example.com/avatars/example-user.png\",\n \"first_name\": \"Example\",\n \"last_name\": \"User\",\n \"is_deleted\": false\n }\n }\n ]\n }\n}"}],"_postman_id":"fc3a6beb-e42b-4612-a400-8fda02250b82"},{"name":"Create a Unit","id":"a9159c93-0944-4d0b-808b-ae9869637b2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"uprn\":\"BLK-00123-ALP\",\n\t\"address_1\":\"Flat 15, Alpha House\",\n\t\"address_2\":\"123 Main Road\",\n\t\"town\":\"London\",\n\t\"county\":\"\",\n\t\"postcode\":\"AB12 3CD\",\n\t\"property_type\":\"Residence\",\n\t\"parent_uprn\":\"BLK123\",\n \"parent_property_id\":\"\",\n \"property_data\": [\n {\n \"key\": \"Property Number\",\n \"value\": \"123456\"\n },\n {\n \"key\": \"Tenancy Type\",\n \"value\": \"Social Flat\"\n }\n ]\n}"},"url":"{{public_api_url}}unit","description":"\nRequires: This endpoint requires an API role of API Client
\n
\n","urlObject":{"host":["{{public_api_url}}unit"],"query":[],"variable":[]}},"response":[{"id":"8c9e4e53-20fc-4da0-91a6-d75034c83d62","name":"Create a Unit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"uprn\":\"BLK-00123-ALP\",\n\t\"address_1\":\"Flat 15, Alpha House\",\n\t\"address_2\":\"123 Main Road\",\n\t\"town\":\"London\",\n\t\"county\":\"\",\n\t\"postcode\":\"AB12 3CD\",\n\t\"property_type\":\"Residence\",\n\t\"parent_uprn\":\"BLK123\",\n \"parent_property_id\":\"\",\n \"property_data\": [\n {\n \"key\": \"Property Number\",\n \"value\": \"123456\"\n },\n {\n \"key\": \"Tenancy Type\",\n \"value\": \"Social Flat\"\n }\n ]\n}"},"url":"{{public_api_url}}unit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Property_created_no_parent_found_by_uprn\",\n \"data\": {\n \"id\": \"\",\n \"uprn\": \"\",\n \"address_1\": \"Example Flat 15, Example House\",\n \"address_2\": \"123 Example Road\",\n \"town\": \"Example Town\",\n \"county\": null,\n \"postcode\": \"EX12 3AB\",\n \"resident\": null,\n \"slug\": null,\n \"updated_at\": \"2026-03-12 11:10:48\",\n \"address_string\": \"Example Flat 15, Example House, 123 Example Road, Example Town, EX12 3AB\",\n \"property_type\": \"Residence\",\n \"parent_property\": {},\n \"child_properties\": [],\n \"organisation\": {\n \"name\": \"Example Housing Group\",\n \"two_factor\": null,\n \"logo\": null\n },\n \"property_data\": {\n \"property_number\": \"123456\",\n \"tenancy_type\": \"Example Tenancy Type\"\n },\n \"certificates\": [],\n \"assets\": [],\n \"compliance_statuses\": [],\n \"compliance_streams\": [],\n \"flags\": [],\n \"logs\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"model_id\": \"\",\n \"model_type\": \"