Retrieves a paginated list of actions. Results can be filtered by action type, status, associated certificate, property, or material, as well as by creation or update date ranges.
\nComma-separated list parameters: action_type and action_status accept multiple values as a comma-separated string (e.g., Open,Closed). Use the corresponding library endpoints to retrieve all valid values:
Action types: GET library/action-types
Action statuses: GET library/action-statuses
Date filters (created_before, created_since, updated_before, updated_since) must follow the YYYY-MM-DD format.
Comma separated list of action types. You can find these by calling GET library/action-types
\n","type":"text/plain"},"key":"action_type","value":"Water Risk Actions,Fire Risk Actions"},{"disabled":true,"description":{"content":"Comma separated list of action statuses. You can find these by calling GET library/action-statuses
\n","type":"text/plain"},"key":"action_status","value":"Open,Closed"},{"disabled":true,"key":"certificate_id","value":""},{"disabled":true,"key":"property_id","value":""},{"disabled":true,"key":"material_id","value":""},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"created_before","value":"2020-01-10"},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"created_since","value":"2025-01-10"},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"updated_before","value":"2020-01-10"},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"updated_since","value":"2025-01-10"},{"disabled":true,"description":{"content":"Return shallow response (no nested relationships)
\n","type":"text/plain"},"key":"shallow","value":"false"}],"variable":[]}},"response":[{"id":"446420dc-2840-4c12-8245-98e454f41a52","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{public_api_v2_domain}}action","host":["{{public_api_v2_domain}}action"],"query":[{"key":"limit","value":"100","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"action_type","value":"Water Risk Actions,Fire Risk Actions","description":"Comma separated list of action types. You can find these by calling GET library/action-types","disabled":true},{"key":"action_status","value":"Open,Closed","description":"Comma separated list of action statuses. You can find these by calling GET library/action-statuses","disabled":true},{"key":"certificate_id","value":"","type":"text","disabled":true},{"key":"property_id","value":"","type":"text","disabled":true},{"key":"material_id","value":"","disabled":true},{"key":"created_before","value":"2020-01-10","description":"YYYY-MM-DD","type":"text","disabled":true},{"key":"created_since","value":"2025-01-10","description":"YYYY-MM-DD","type":"text","disabled":true},{"key":"updated_before","value":"2020-01-10","description":"YYYY-MM-DD","type":"text","disabled":true},{"key":"updated_since","value":"2025-01-10","description":"YYYY-MM-DD","type":"text","disabled":true},{"key":"shallow","value":"false","description":"Return shallow response (no nested relationships)","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"action_type\": \"Water Risk Actions\",\n \"action_status\": \"Sent For Approval\",\n \"team\": \"Fire Team\",\n \"owner\": \"Mr Dave Example\",\n \"values\": {\n \"Site Risk Rating\": \"5\",\n \"Priority\": \"High\",\n \"Issue\": \"No policy identified.\",\n \"Regulation\": \"Health and Safety at Work etc. Act 1974 S2(3).\",\n \"Refernece\": \"There is a legal requirement for a written safety policy where five or more employees exist.\",\n \"Required Action\": \"Produce a policy that includes Legionella management in line with HSG 65.\",\n \"Action No\": \"1\"\n },\n \"certificate_id\": 123456,\n \"property_id\": 123456,\n \"material_id\": null,\n \"deadline\": \"2027-03-11\",\n \"completed_at\": \"2026-12-22 12:43:25\",\n \"approved_at\": null,\n \"created_at\": \"2026-04-17 12:16:12\",\n \"updated_at\": \"2026-12-12 01:01:12\",\n \"certificate\": {\n \"certificate_id\": 123456,\n \"certificate_instance\": \"WRA Contractor Assessment\",\n \"certificate_type\": \"WRA\",\n \"document_id\": 123456,\n \"contractor\": \"Test Contractor\",\n \"issue_date\": \"2026-12-12\",\n \"certificate_number\": \"ABC-123\"\n },\n \"property\": {\n \"property_id\": 123456,\n \"uprn\": \"B999999\",\n \"property_full_address\": \"123 Main Road, London, N99 1AB\"\n },\n \"material\": null,\n \"notes\": [\n {\n \"note\": \"This has been reviewed by the team and completed.\",\n \"user\": \"Mr Bob User\",\n \"tags\": [],\n \"created_at\": \"2026-12-22 12:43:22\",\n \"updated_at\": \"2026-12-22 12:43:22\"\n }\n ],\n \"logs\": [\n {\n \"email\": \"bob@example.com\",\n \"message\": \"This actions status was updated to Sent For Approval. \",\n \"user\": \"Mr Bob User\",\n \"created_at\": \"2026-12-22 12:43:25\",\n \"updated_at\": \"2026-12-22 12:43:25\"\n },\n {\n \"email\": \"bob@example.com\",\n \"message\": \"This action was updated.\",\n \"user\": \"Mr Bob User\",\n \"created_at\": \"2026-12-22 12:43:25\",\n \"updated_at\": \"2026-12-22 12:43:25\"\n }\n ]\n },\n {\n \"id\": 123457,\n \"action_type\": \"EICR Observations\",\n \"action_status\": \"Open\",\n \"team\": null,\n \"owner\": null,\n \"values\": {\n \"Observation Item Number\": \"1\",\n \"Observation\": \"PLASTIC DB\",\n \"Observation Code\": \"C3\"\n },\n \"certificate_id\": 123457,\n \"property_id\": 123457,\n \"material_id\": null,\n \"deadline\": \"2019-09-02\",\n \"completed_at\": null,\n \"approved_at\": null,\n \"created_at\": \"2020-12-17 16:42:38\",\n \"updated_at\": \"2024-06-05 01:01:15\",\n \"certificate\": {\n \"certificate_id\": 123457,\n \"certificate_instance\": \"Communal EICR 18th (2018)\",\n \"certificate_type\": \"EICR\",\n \"document_id\": 123457,\n \"contractor\": \"Test Contractor\",\n \"issue_date\": \"2019-06-04\",\n \"certificate_number\": \"ABC-002\"\n },\n \"property\": {\n \"property_id\": 123457,\n \"uprn\": \"B999991\",\n \"property_full_address\": \"124 Main Road, London, N99 3AB\"\n },\n \"material\": null,\n \"notes\": [],\n \"logs\": []\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/action?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/action?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/action?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/action\",\n \"per_page\": \"2\",\n \"to\": 2\n }\n}"}],"_postman_id":"f29f14d0-cfdd-481e-b3fd-ed2c9b0d6d15"},{"name":"Get Action","event":[{"listen":"test","script":{"id":"6ab82aa4-f866-473c-b088-34a5f3c646e5","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b2ea1493-cc39-439c-8da2-877652a169db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}action/{{action_id}}","description":"Retrieves a single action by its unique identifier.
\nThe action_id path variable must correspond to an existing action. If the action is not found, a 404 response will be returned.
Set shallow to true to reduce response payload size by omitting nested relationship data.
Return shallow response (no nested relationships)
\n","type":"text/plain"},"key":"shallow","value":"false"}],"variable":[]}},"response":[{"id":"729bb6ca-f5a7-4e15-9480-f63b8bb522fb","name":"200 OK","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{public_api_v2_domain}}action/{{action_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 123456,\n \"action_type\": \"Water Risk Actions\",\n \"action_status\": \"Sent For Approval\",\n \"team\": \"Fire Team\",\n \"owner\": \"Mr Dave Example\",\n \"values\": {\n \"Site Risk Rating\": \"5\",\n \"Priority\": \"High\",\n \"Issue\": \"No policy identified.\",\n \"Regulation\": \"Health and Safety at Work etc. Act 1974 S2(3).\",\n \"Refernece\": \"There is a legal requirement for a written safety policy where five or more employees exist.\",\n \"Required Action\": \"Produce a policy that includes Legionella management in line with HSG 65.\",\n \"Action No\": \"1\"\n },\n \"certificate_id\": 123456,\n \"property_id\": 123456,\n \"material_id\": null,\n \"deadline\": \"2027-03-11\",\n \"completed_at\": \"2026-12-22 12:43:25\",\n \"approved_at\": null,\n \"created_at\": \"2026-04-17 12:16:12\",\n \"updated_at\": \"2026-12-12 01:01:12\",\n \"certificate\": {\n \"certificate_id\": 123456,\n \"certificate_instance\": \"WRA Contractor Assessment\",\n \"certificate_type\": \"WRA\",\n \"document_id\": 123456,\n \"contractor\": \"Test Contractor\",\n \"issue_date\": \"2026-12-12\",\n \"certificate_number\": \"ABC-123\"\n },\n \"property\": {\n \"property_id\": 123456,\n \"uprn\": \"B999999\",\n \"property_full_address\": \"123 Main Road, London, N99 1AB\"\n },\n \"material\": null,\n \"notes\": [\n {\n \"note\": \"This has been reviewed by the team and completed.\",\n \"user\": \"Mr Bob User\",\n \"tags\": [],\n \"created_at\": \"2026-12-22 12:43:22\",\n \"updated_at\": \"2026-12-22 12:43:22\"\n }\n ],\n \"logs\": [\n {\n \"email\": \"bob@example.com\",\n \"message\": \"This actions status was updated to Sent For Approval. \",\n \"user\": \"Mr Bob User\",\n \"created_at\": \"2026-12-22 12:43:25\",\n \"updated_at\": \"2026-12-22 12:43:25\"\n },\n {\n \"email\": \"bob@example.com\",\n \"message\": \"This action was updated.\",\n \"user\": \"Mr Bob User\",\n \"created_at\": \"2026-12-22 12:43:25\",\n \"updated_at\": \"2026-12-22 12:43:25\"\n }\n ]\n }\n}"}],"_postman_id":"b2ea1493-cc39-439c-8da2-877652a169db"},{"name":"Add Flag","id":"fd1108e1-38de-44ea-8061-ba471537a992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"flag_name\": \"Capped Meter\",\n \"expiry_date\": \"2026-03-02\"\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_v2_domain}}action/{{action_id}}/flag","description":"Adds a flag to a specific Action, allowing you to mark it with a named flag and an optional expiry date.
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
Flags: Use the library endpoint to retrieve all valid values for flag_name:
GET library/flagsString
\n"},{"key":"evidence","description":"File. Optional. 1mb max filesize.
\n","type":"file","src":"postman-cloud:///1f0b0e05-44f4-4750-b39c-8f0b6f5955b0"}]},"url":"{{public_api_v2_domain}}action/{{action_id}}/note","description":"Will add a note to an Action, with optional attachment.
\n","urlObject":{"path":["{{action_id}}","note"],"host":["{{public_api_v2_domain}}action"],"query":[],"variable":[]}},"response":[],"_postman_id":"608f56e9-ce8a-4ed9-b920-7548404947cb"},{"name":"Close an Action","event":[{"listen":"test","script":{"id":"85bb63b0-9666-429c-aa0b-5baf536dbe95","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1ea4c654-20d0-4ec7-b35c-ce2881a68298","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"evidence","description":"File. Optional. 1mb max filesize.
\n","type":"file","src":"postman-cloud:///1f0b0e05-44f4-4750-b39c-8f0b6f5955b0"},{"key":"note","value":"A completion note","description":"String
\n","type":"text"},{"key":"completed_by","value":"geoff.bronson@nhg.org.uk","description":"A valid email address
\n","type":"text"},{"key":"approved_by","value":"helen.griffey@nhg.org.uk","description":"A valid email address
\n","type":"text"},{"key":"_method","value":"PATCH","type":"text","uuid":"44f40da4-0fc2-4db6-99af-a7053d1666b6"}]},"url":"{{public_api_v2_domain}}action/{{action_id}}/close","description":"Closes a specific Action, marking it as complete.
\nThe request body must be sent as multipart/form-data.
Users: Use the library endpoint to retrieve all valid users for completed_by and `approved_by`:
GET library/usersChange the ownership of an action. Both owner and team are optional, but one of them must be present.
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
Users / Teams: Use the corresponding library endpoint to retrieve all valid values:
\nUsers: GET library/users
Teams: GET library/teams
This will change the action to any status other than Closed (to close an action use the \"Close an Action\" endpoint).
\naction_status must be either:
\nOpenSent for ApprovalRejected
If the new status is Sent for Approval you can optionally send the completed_by, which is the email address of the user who completed the action. If omitted the completed_by user will be the authenticated API user.
The request body must be sent as JSON.
\nReturns a 200 OK on success.
Use the corresponding library endpoint to retrieve all valid values:
\nUsers: GET library/users
Action Statuses: GET library/action-statuses
Removes a flag from a specific Action
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
Flags: Use the library endpoint to retrieve all valid values for flag_name:
GET library/flagsRetrieves a paginated list of assets. Use the query parameters below to filter and paginate the results.
\nComma-separated list parameters: asset_type and fault_status accept multiple values as a comma-separated string (e.g., Open,Closed). Use the corresponding library endpoints to retrieve all valid values:
Asset types: GET library/asset-types
Fault statuses: GET library/fault-statuses
Date filters (created_before, created_since, updated_before, updated_since) must follow the YYYY-MM-DD format.
Comma separated list of asset types. You can find these by calling GET library/asset-types
\n","type":"text/plain"},"key":"asset_type","value":"Smoke Alarm"},{"disabled":true,"key":"uprn","value":"B9999999"},{"disabled":true,"description":{"content":"Comma separated list of fault statuses. You can find these by calling GET library/fault-statuses
\n","type":"text/plain"},"key":"fault_status","value":"Dismissed,To Review"},{"disabled":true,"description":{"content":"Must be 1 or 0 for true or false
\n","type":"text/plain"},"key":"compliant","value":"1"},{"disabled":true,"key":"created_since","value":"2020-01-01"},{"disabled":true,"key":"created_before","value":"2025-01-01"},{"disabled":true,"key":"updated_since","value":"2020-01-01"},{"disabled":true,"key":"updated_before","value":"2025-01-01"},{"disabled":true,"key":"shallow","value":"false"}],"variable":[]}},"response":[{"id":"9dd42a0a-e042-4984-be42-5766925cf5c2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}asset","host":["{{public_api_v2_domain}}asset"],"query":[{"key":"limit","value":"5","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"property_id","value":"","type":"text","disabled":true},{"key":"certificate_id","value":"","disabled":true},{"key":"asset_type","value":"Smoke Alarm","description":"Comma separated list of asset types. You can find these by calling GET library/asset-types","disabled":true},{"key":"uprn","value":"B9999999","disabled":true},{"key":"fault_status","value":"Dismissed,To Review","description":"Comma separated list of fault statuses. You can find these by calling GET library/fault-statuses","disabled":true},{"key":"compliant","value":"1","description":"Must be 1 or 0 for true or false","disabled":true},{"key":"created_since","value":"2020-01-01","type":"text","disabled":true},{"key":"created_before","value":"2025-01-01","type":"text","disabled":true},{"key":"updated_since","value":"2020-01-01","type":"text","disabled":true},{"key":"updated_before","value":"2025-01-01","type":"text","disabled":true},{"key":"shallow","value":"false","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"asset_type\": \"Smoke Alarm\",\n \"property_id\": 123456,\n \"compliant\": false,\n \"faults\": [\n {\n \"fault_id\": 123456,\n \"message\": \"Appliance has not been marked safe to use.\",\n \"corrective_action\": \"Fix appliance\",\n \"fault_status\": \"Rejected\",\n \"from_inspection_id\": 123456,\n \"superceded\": 1,\n \"created_at\": null,\n \"updated_at\": \"2022-07-08 01:17:13\"\n }\n ],\n \"created_at\": \"2018-04-11 11:08:32\",\n \"updated_at\": \"2018-04-11 11:08:34\",\n \"notes\": []\n },\n {\n \"id\": 123457,\n \"asset_type\": \"Gas Cooker\",\n \"property_id\": 123457,\n \"compliant\": false,\n \"faults\": [\n {\n \"fault_id\": 123457,\n \"message\": \"Safety Device Correct Operation field is not marked as Yes or Pass\",\n \"corrective_action\": \"\",\n \"fault_status\": \"Rejected\",\n \"from_inspection_id\": 123457,\n \"superceded\": 1,\n \"created_at\": \"2021-11-17 01:19:21\",\n \"updated_at\": \"2021-11-17 01:19:21\"\n }\n ],\n \"created_at\": \"2018-04-01 09:04:13\",\n \"updated_at\": \"2018-04-01 09:04:14\",\n \"notes\": []\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/asset?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/asset?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/asset?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/asset\",\n \"per_page\": \"2\",\n \"to\": 2\n }\n}"}],"_postman_id":"5dc1d230-af24-4ada-9ff0-f6b7a755ae02"},{"name":"Get Asset","event":[{"listen":"test","script":{"id":"25d6b23a-5a83-4cf0-9a53-09805fb0070d","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6329d6af-21cb-4304-9bf6-b9628465a54c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}asset/{{asset_id}}","description":"Retrieves a single asset by its ID.
\nReturns a single asset object under the data key, including:
id — Unique identifier of the asset.asset_type — The type of asset (e.g. Smoke Alarm).property_id — The ID of the property the asset belongs to.compliant — Whether the asset is currently compliant (true or false).faults — A list of faults associated with the asset, each containing:fault_id — Unique identifier of the fault.message — Description of the fault.corrective_action — Recommended action to resolve the fault.fault_status — Current status of the fault.from_inspection_id — The inspection that raised the fault.superceded — Whether the fault has been superseded.created_at — Timestamp when the fault was created.Retrieves a paginated list of certificates. Use the optional parameters to filter and paginate results.
\nReturns a paginated list of certificates.
\n","urlObject":{"host":["{{public_api_v2_domain}}certificate"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"description":{"content":"Comma separated list of certificate instances. You can find these by calling GET library/certificate-instances
\n","type":"text/plain"},"key":"certificate_instance","value":""},{"disabled":true,"description":{"content":"Comma separated list of complliance streams instances. You can find these by calling GET library/compliance-streams
\n","type":"text/plain"},"key":"compliance_stream","value":"Gas,Asbestos"},{"disabled":true,"key":"property_id","value":""},{"disabled":true,"description":{"content":"Text search for instance, property address, contractor, compliance stream or filename
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"key":"uprn","value":""},{"disabled":true,"key":"created_since","value":""},{"disabled":true,"key":"created_before","value":""},{"disabled":true,"key":"updated_since","value":""},{"disabled":true,"key":"updated_before","value":""}],"variable":[]}},"response":[{"id":"817390c6-e7cb-4300-82ef-55fffa89838e","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}certificate","host":["{{public_api_v2_domain}}certificate"],"query":[{"key":"limit","value":"10","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"certificate_instance","value":"","description":"Comma separated list of certificate instances. You can find these by calling GET library/certificate-instances","disabled":true},{"key":"compliance_stream","value":"Gas,Asbestos","description":"Comma separated list of complliance streams instances. You can find these by calling GET library/compliance-streams","disabled":true},{"key":"property_id","value":"","type":"text","disabled":true},{"key":"search","value":"","description":"Text search for instance, property address, contractor, compliance stream or filename","disabled":true},{"key":"uprn","value":"","type":"text","disabled":true},{"key":"created_since","value":"","disabled":true},{"key":"created_before","value":"","disabled":true},{"key":"updated_since","value":"","disabled":true},{"key":"updated_before","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"property_id\": 123456,\n \"uprn\": \"B999999\",\n \"certificate_instance\": \"Generic EICR\",\n \"certificate_type\": \"EICR\",\n \"compliance_stream\": \"Electrical\",\n \"contractor\": \"Various\",\n \"values\": {\n \"Contractor Name\": \"Test Contractor\",\n \"Certificate Number\": \"DOMEICR/999999999\",\n \"Issue Date\": \"2019-05-31\",\n \"Certificate Title\": \"Domestic Electrical Installation Condition Report\",\n \"Status\": \"satisfactory\",\n \"Purpose Of Report\": \"To assess compliance with BS 7671.\",\n \"Next Inspection\": \"5 Years\",\n \"Age Of Installation\": \"20\",\n \"Engineer Name\": \"Test Engineer\",\n \"Signed By Contractor\": \"1\",\n \"Engineer ID\": \"9999999999\",\n \"Signed Supervisor\": \"1\"\n },\n \"faults\": [],\n \"created_at\": \"2020-08-30 13:56:10\",\n \"updated_at\": \"2024-06-01 01:00:48\"\n },\n {\n \"id\": 123457,\n \"property_id\": 123457,\n \"uprn\": \"9999999991\",\n \"certificate_instance\": \"Electrical Bulk Upload\",\n \"certificate_type\": \"EICR\",\n \"compliance_stream\": \"Electrical\",\n \"contractor\": \"Various\",\n \"values\": {\n \"Certificate Number\": \"Load_1711\",\n \"Status\": \"Satisfactory\",\n \"Signed By Contractor\": \"1\",\n \"Signed Supervisor\": \"1\"\n },\n \"faults\": [],\n \"created_at\": \"2020-11-13 16:12:25\",\n \"updated_at\": \"2024-06-01 01:00:48\"\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/certificate?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/certificate?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/certificate?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/certificate\",\n \"per_page\": \"2\",\n \"to\": 2\n }\n}"}],"_postman_id":"eae79171-fa7a-48c0-b986-d8dc7e3133b8"},{"name":"Get Certificate","event":[{"listen":"test","script":{"id":"7fa05d5a-81b4-410b-a4b8-ae3d87e5ebd3","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"756c2c6a-6609-40f3-8779-6e084af1cd9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}certificate/{{certificate_id}}","description":"Retrieves a single certificate by its ID.
\nReturns the full details of the specified certificate.
\n","urlObject":{"path":["{{certificate_id}}"],"host":["{{public_api_v2_domain}}certificate"],"query":[{"disabled":true,"key":"shallow","value":"false"}],"variable":[]}},"response":[{"id":"f517985f-976f-4bc7-a22c-63bdcd6bda62","name":"Get Certificate","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}certificate/{{certificate_id}}","host":["{{public_api_v2_domain}}certificate"],"path":["{{certificate_id}}"],"query":[{"key":"shallow","value":"false","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 123456,\n \"property_id\": 123456,\n \"uprn\": \"B999999\",\n \"certificate_instance\": \"Generic EICR\",\n \"certificate_type\": \"EICR\",\n \"compliance_stream\": \"Electrical\",\n \"contractor\": \"Various\",\n \"values\": {\n \"Contractor Name\": \"Test Contractor\",\n \"Certificate Number\": \"DOMEICR/999999999\",\n \"Issue Date\": \"2019-05-31\",\n \"Certificate Title\": \"Domestic Electrical Installation Condition Report\",\n \"Status\": \"satisfactory\",\n \"Purpose Of Report\": \"To assess compliance with BS 7671.\",\n \"Next Inspection\": \"5 Years\",\n \"Age Of Installation\": \"20\",\n \"Engineer Name\": \"Test Engineer\",\n \"Signed By Contractor\": \"1\",\n \"Engineer ID\": \"9999999999\",\n \"Signed Supervisor\": \"1\"\n },\n \"faults\": [],\n \"created_at\": \"2020-08-30 13:56:10\",\n \"updated_at\": \"2024-06-01 01:00:48\"\n }\n}"}],"_postman_id":"756c2c6a-6609-40f3-8779-6e084af1cd9d"},{"name":"Add Flag","id":"f6bd5abc-2beb-412e-8f11-667398c609da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"flag_name\": \"Capped Meter\",\n \"expiry_date\": \"2027-03-02\"\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_v2_domain}}certificate/{{certificate_id}}/flag","description":"Adds a flag to a specific Certificate, allowing you to mark it with a named flag and an optional expiry date.
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
Flags: Use the library endpoint to retrieve all valid values for flag_name:
GET library/flagsRemoves a flag from a specific Certificate
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
Flags: Use the library endpoint to retrieve all valid values for flag_name:
GET library/flagsRetrieves a paginated list of documents available to the authenticated user.
\nUse this endpoint to fetch documents associated with your account. Results are paginated and can be filtered by certificate instance, document status, and date ranges for creation or last update.
\nMethod: GET
Endpoint: {{public_api_v2_domain}}document
This endpoint requires a valid authenticated session. Ensure your request includes the appropriate authentication credentials (e.g. Bearer token or API key) as required by the API.
\nA successful request returns a 200 OK status with a JSON body containing a paginated list of documents matching the specified filters.
created_since, created_before, updated_since, updated_before) must follow the YYYY-MM-DD format.certificate_instance and document_status parameters accept comma-separated values, allowing you to filter by multiple values in a single request.limit and page parameters together to paginate through large result sets.Comma separated list of certificate instances. You can find these by calling GET library/certificate-instances
\n","type":"text/plain"},"key":"certificate_instance","value":""},{"disabled":true,"description":{"content":"Comma separated list of document statuses You can find these by calling GET library/document-statuses
\n","type":"text/plain"},"key":"document_status","value":""},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"created_since","value":""},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"created_before","value":""},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"updated_since","value":""},{"disabled":true,"description":{"content":"YYYY-MM-DD
\n","type":"text/plain"},"key":"updated_before","value":""}],"variable":[]}},"response":[{"id":"b4291d37-e64d-4a04-8772-5bf89351f0ec","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}document","host":["{{public_api_v2_domain}}document"],"query":[{"key":"limit","value":"10","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"certificate_instance","value":"","description":"Comma separated list of certificate instances. You can find these by calling GET library/certificate-instances","disabled":true},{"key":"document_status","value":"","description":"Comma separated list of document statuses You can find these by calling GET library/document-statuses","disabled":true},{"key":"created_since","value":"","description":"YYYY-MM-DD","disabled":true},{"key":"created_before","value":"","description":"YYYY-MM-DD","disabled":true},{"key":"updated_since","value":"","description":"YYYY-MM-DD","disabled":true},{"key":"updated_before","value":"","description":"YYYY-MM-DD","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"certificate_instance\": \"Test Instance\",\n \"document_type\": \"UPLOADED\",\n \"document_status\": \"LOADED_SUCCESSFULLY\",\n \"filename\": \"my-test-file.pdf\",\n \"storage_filename\": \"my-test-file-unique.pdf\",\n \"loaded_by\": \"Ms Test User\",\n \"loaded_on\": \"2019-02-19 18:34:19\",\n \"created_at\": \"2019-02-19 18:34:19\",\n \"updated_at\": \"2022-04-30 00:00:44\"\n },\n {\n \"id\": 123457,\n \"certificate_instance\": \"Test Instance\",\n \"document_type\": \"UPLOADED\",\n \"document_status\": \"LOADED_SUCCESSFULLY\",\n \"filename\": \"test-lgsr.pdf\",\n \"storage_filename\": \"test-lgsr-unique.pdf\",\n \"loaded_by\": \"Ms Test User\",\n \"loaded_on\": \"2019-12-16 06:01:17\",\n \"created_at\": \"2019-12-16 06:01:17\",\n \"updated_at\": \"2022-04-30 00:00:44\"\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/document?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/document?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/document?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/document\",\n \"per_page\": \"2\",\n \"to\": 2\n }\n}"}],"_postman_id":"d2dce7c1-1a04-43b9-a642-3ae535674c9e"},{"name":"Get Document","event":[{"listen":"test","script":{"id":"f0cb589c-1a94-4ea3-98d4-db022d78fbe0","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e6ae5de8-a186-4e1b-a18d-91ae4118e2ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}document/{{document_id}}","description":"Retrieves a single document by its unique identifier.
\nThis endpoint requires a Bearer token. Pass your API key using the {{api-key}} variable.
Returns a document object on success.
\n","urlObject":{"path":["{{document_id}}"],"host":["{{public_api_v2_domain}}document"],"query":[{"disabled":true,"key":"shallow","value":"false"}],"variable":[]}},"response":[{"id":"1ba65cb1-dfec-4ee2-a056-e8cd28cefbc8","name":"Get Document","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}document/{{document_id}}","host":["{{public_api_v2_domain}}document"],"path":["{{document_id}}"],"query":[{"key":"shallow","value":"false","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 123456,\n \"certificate_instance\": \"Test Instance\",\n \"document_type\": \"UPLOADED\",\n \"document_status\": \"LOADED_SUCCESSFULLY\",\n \"filename\": \"my-test-file.pdf\",\n \"storage_filename\": \"my-test-file-unique.pdf\",\n \"loaded_by\": \"Ms Test User\",\n \"loaded_on\": \"2019-02-19 18:34:19\",\n \"created_at\": \"2019-02-19 18:34:19\",\n \"updated_at\": \"2022-04-30 00:00:44\"\n }\n}"}],"_postman_id":"e6ae5de8-a186-4e1b-a18d-91ae4118e2ad"},{"name":"Get Document Download URL","event":[{"listen":"test","script":{"id":"e25b96c6-488a-4aec-bb14-a0b7f8f7f74c","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"af328435-d17d-401f-840a-56998ae38b78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}document/{{document_id}}/download-url","description":"Retrieves a pre-signed download URL for a specific document by its unique identifier.
\nThis endpoint requires a Bearer token. Pass your API key using the {{api-key}} variable.
Returns a download URL object on success.
\n","urlObject":{"path":["{{document_id}}","download-url"],"host":["{{public_api_v2_domain}}document"],"query":[],"variable":[]}},"response":[{"id":"03b48b47-bb14-400b-a312-e17f0b270016","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{public_api_v2_domain}}document/{{document_id}}/download-url"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"download_url\": \"{{download-url}}\"\n}"}],"_postman_id":"af328435-d17d-401f-840a-56998ae38b78"},{"name":"PDF","id":"05614f8c-0cf3-42ea-a592-9ba2a1ad101d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"document","type":"file","uuid":"8fb27b65-c0ab-4d37-b4de-6717bbb83979","description":"A PDF file
\n","value":null}]},"url":"{{public_api_v2_domain}}pdf","description":"Uploads a PDF document to the system.
\nThis endpoint accepts a multipart/form-data request body.
This endpoint requires a Bearer token. Pass your API key using the {{api-key}} variable.
Returns the created document ID on success.
\n","urlObject":{"host":["{{public_api_v2_domain}}pdf"],"query":[],"variable":[]}},"response":[],"_postman_id":"05614f8c-0cf3-42ea-a592-9ba2a1ad101d"},{"name":"Fetch Upload URL","id":"f7a39b52-5e8c-4d96-aa80-ae2ebb67c778","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"filename\": \"example-certificate.pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_v2_domain}}pdf/upload-url","description":"Generates a pre-signed upload URL for uploading a PDF document to the system. We will create your document record, but then you must separately utilise the provided upload URL to pass the PDF to True Compliance. Use for files that exceed the 1Mb limit of POST pdf
This endpoint accepts a application/json request body.
This endpoint requires a Bearer token. Pass your API key using the {{api-key}} variable.
Returns a pre-signed upload URL and the new document ID on success.
\n","urlObject":{"path":["upload-url"],"host":["{{public_api_v2_domain}}pdf"],"query":[],"variable":[]}},"response":[{"id":"e8be9ae6-a5b8-4d43-9bb9-9806e61828c8","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"filename\": \"example-certificate.pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_v2_domain}}pdf/upload-url"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"upload_url\": \"{{presiged-upload-url}}\",\n \"document_id\": 123456\n}"}],"_postman_id":"f7a39b52-5e8c-4d96-aa80-ae2ebb67c778"}],"id":"5dd4b941-f4cf-4005-ba7b-f40421026cb8","_postman_id":"5dd4b941-f4cf-4005-ba7b-f40421026cb8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{public_api_v2_token}}"}]},"isInherited":true,"source":{"_postman_id":"bd46f7ec-2f39-4add-9eff-160cb4bda033","id":"bd46f7ec-2f39-4add-9eff-160cb4bda033","name":"True Compliance Public API v2","type":"collection"}}},{"name":"Library","item":[{"name":"Get Action Statuses","event":[{"listen":"test","script":{"id":"89d311c1-b965-4929-8aec-811f071ea224","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d72394b2-8abe-4aec-af2f-78ad3e9a7160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/action-statuses","description":"Retrieves a list of action statuses from the library. Use the optional search parameter to filter results by a text string.
This endpoint is useful for populating the action_status filter when calling Get Actions.
Returns a list of action status values that can be used to filter actions via the action_status query parameter on the Get Actions endpoint.
A text string to search for
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"d72394b2-8abe-4aec-af2f-78ad3e9a7160"},{"name":"Get Action Types","event":[{"listen":"test","script":{"id":"d99e135d-db38-4814-a4ef-a870abd48786","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d489e428-0a42-4d48-a22b-f1f6c7eab512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/action-types","description":"Retrieves a list of action types from the library. Use the optional search parameter to filter results by a text string.
This endpoint is useful for populating the action_type filter when calling Get Actions.
Returns a list of action type values that can be used to filter actions via the action_type query parameter on the Get Actions endpoint.
A text string to search for
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"d489e428-0a42-4d48-a22b-f1f6c7eab512"},{"name":"Get Asset Types","event":[{"listen":"test","script":{"id":"4978cd48-2186-4c71-a4ff-a63e4663a9c4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e0925103-884c-4bf4-94cd-befc52e973b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/asset-types","description":"Retrieves a paginated list of asset types from the library. Use the optional search parameter to filter results by a text string.
Returns a paginated list of asset type values.
\n","urlObject":{"path":["asset-types"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":"gas"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"e0925103-884c-4bf4-94cd-befc52e973b5"},{"name":"Get Certificate Instances","event":[{"listen":"test","script":{"id":"9edfbc88-cb2a-41be-b07a-7b3457851626","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"27369b8c-bc98-4c2e-9165-50c007a6d92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/certificate-instances","description":"Retrieves a paginated list of certificate instances from the library.
\nReturns a paginated list of certificate instances.
\n","urlObject":{"path":["certificate-instances"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":null},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"27369b8c-bc98-4c2e-9165-50c007a6d92e"},{"name":"Get Compliance Streams","event":[{"listen":"test","script":{"id":"c7ec304c-a8f9-4d76-bba5-57d4b79c2c98","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7e2f95c3-2994-4b37-873e-de4555afeffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/compliance-streams","description":"Retrieves a list of compliance streams from the library. Use the optional search parameter to filter results.
Returns a list of compliance stream values.
\n","urlObject":{"path":["compliance-streams"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"7e2f95c3-2994-4b37-873e-de4555afeffb"},{"name":"Get Document Statuses","event":[{"listen":"test","script":{"id":"f3b04e74-c156-460e-b827-8d600e4930f7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d39fd569-fc0f-4b4b-9635-d21746cbedd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/document-statuses","description":"Retrieves a list of document statuses from the library. Use the optional search parameter to filter results by a text string.
Returns a list of document status values.
\n","urlObject":{"path":["document-statuses"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"d39fd569-fc0f-4b4b-9635-d21746cbedd1"},{"name":"Get Fault Statuses","event":[{"listen":"test","script":{"id":"d63a265c-e0aa-4506-ab28-e46cdff91a12","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"bc96b4fe-c9d3-40ba-95dd-2cb9b54c24fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/fault-statuses?search=","description":"Retrieves a list of fault statuses from the library. Use the optional search parameter to filter results by a text string.
Returns a list of fault status values.
\n","urlObject":{"path":["fault-statuses"],"host":["{{public_api_v2_domain}}library"],"query":[{"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"bc96b4fe-c9d3-40ba-95dd-2cb9b54c24fe"},{"name":"Get Flags","event":[{"listen":"test","script":{"id":"4e1569cf-fd67-4f42-80ba-f58f3d9964d7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3d8a20aa-bc78-4fc0-8d85-20328afa9de1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/flags","description":"Retrieves a paginated list of flags from the library. Use the optional parameters to filter and paginate results.
\nThis endpoint is useful for populating the flag_name field when calling Add Flag.
Returns a paginated list of flag values that can be used when adding or removing flags on actions, certificates, or units.
\n","urlObject":{"path":["flags"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":"warning"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"description":{"content":"unit,certificate or action
\n","type":"text/plain"},"key":"type","value":"unit"}],"variable":[]}},"response":[],"_postman_id":"3d8a20aa-bc78-4fc0-8d85-20328afa9de1"},{"name":"Get Material Types","event":[{"listen":"test","script":{"id":"e3f1c72c-7d26-4d91-ba3d-472254a7b7fe","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"03d2e068-7ba0-4717-b47a-9873baa3b930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/material-types","description":"Retrieves a list of material types from the library. Use the optional search parameter to filter results by a text string.
Returns a list of material type values.
\n","urlObject":{"path":["material-types"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"03d2e068-7ba0-4717-b47a-9873baa3b930"},{"name":"Get Notification Types","event":[{"listen":"test","script":{"id":"09d925a3-a3bd-43ba-ac23-2073578a0b97","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"2c5889ab-9b92-4929-8fa7-06b79b473c2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/notification-types","description":"Retrieves a list of notification types from the library. Use the optional search parameter to filter results by a text string.
Returns a list of notification type values.
\n","urlObject":{"path":["notification-types"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"2c5889ab-9b92-4929-8fa7-06b79b473c2b"},{"name":"Get Property Types","event":[{"listen":"test","script":{"id":"3bf8899d-bc4c-4d3c-8417-48f0657d6893","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"309101be-80f8-4d0c-953c-a557af5e5cad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/property-types","description":"Retrieves a list of property types from the library. Use the optional parameters to filter results.
\nReturns a list of property type values.
\n","urlObject":{"path":["property-types"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"key":"in_use","value":"1"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"309101be-80f8-4d0c-953c-a557af5e5cad"},{"name":"Get Teams","event":[{"listen":"test","script":{"id":"dde01eba-982b-4589-bdab-fbf1d753d839","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ac14825b-3ae2-4c25-91b8-5ecb251a9e3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/teams","description":"Retrieves a paginated list of teams from the library. Use the optional parameters to filter and paginate results.
\nReturns a paginated list of teams.
\n","urlObject":{"path":["teams"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"ac14825b-3ae2-4c25-91b8-5ecb251a9e3f"},{"name":"Get Users","event":[{"listen":"test","script":{"id":"b7bdcc3a-39c2-444f-ba61-2e823efbf68f","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7750db4c-28c6-408e-90a3-99cfc3a3c3fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}library/users","description":"Retrieves a paginated list of users from the library. Use the optional parameters to filter and paginate results.
\nReturns a paginated list of users.
\n","urlObject":{"path":["users"],"host":["{{public_api_v2_domain}}library"],"query":[{"disabled":true,"description":{"content":"A text string to search for
\n","type":"text/plain"},"key":"search","value":null},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"7750db4c-28c6-408e-90a3-99cfc3a3c3fc"}],"id":"fbbd180c-1094-4d9c-b2c1-bc5c6fc796cd","_postman_id":"fbbd180c-1094-4d9c-b2c1-bc5c6fc796cd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{public_api_v2_token}}"}]},"isInherited":true,"source":{"_postman_id":"bd46f7ec-2f39-4add-9eff-160cb4bda033","id":"bd46f7ec-2f39-4add-9eff-160cb4bda033","name":"True Compliance Public API v2","type":"collection"}}},{"name":"Material","item":[{"name":"Get Materials","event":[{"listen":"test","script":{"id":"9081e396-e864-47c6-86f3-aecd06e62eda","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"46d6fffe-13a2-4372-b9b2-5fd38de6b4e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}material","description":"Retrieves a paginated list of materials. Results can be filtered by compliance stream, material type, property, UPRN, and date ranges for creation or last update.
\nEndpoint: GET {{public_api_v2_domain}}material
Authentication: Requires a valid API key passed via the api-key request header.
Compliance streams: Valid values for compliance_stream can be retrieved by calling GET {{public_api_v2_domain}}library/compliance-streams.
Material types: Valid values for material_type can be retrieved by calling GET {{public_api_v2_domain}}library/material-types.
Date filters: Date values should be provided as ISO 8601 formatted strings (e.g. 2024-01-31). The created_since/created_before and updated_since/updated_before pairs can be used independently or together to define a date range.
Pagination: Use limit and page together to paginate through large result sets.
Comma separated list of compliance streams. You can find these by calling GET library/compliance-streams
\n","type":"text/plain"},"key":"compliance_stream","value":"Asbestos"},{"disabled":true,"description":{"content":"Comma separated list of material types. You can find these by calling GET library/material-types
\n","type":"text/plain"},"key":"material_type","value":"Amosite,Crocidolite,Other"},{"disabled":true,"key":"property_id","value":null},{"disabled":true,"key":"uprn","value":""},{"disabled":true,"key":"created_since","value":""},{"disabled":true,"key":"created_before","value":""},{"disabled":true,"key":"updated_since","value":""},{"disabled":true,"key":"updated_before","value":""}],"variable":[]}},"response":[{"id":"a9fc961b-1456-450f-b538-c71810404a69","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}material","host":["{{public_api_v2_domain}}material"],"query":[{"key":"limit","value":"10","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"compliance_stream","value":"Asbestos","description":"Comma separated list of compliance streams. You can find these by calling GET library/compliance-streams","type":"text","disabled":true},{"key":"material_type","value":"Amosite,Crocidolite,Other","description":"Comma separated list of material types. You can find these by calling GET library/material-types","disabled":true},{"key":"property_id","value":null,"type":"text","disabled":true},{"key":"uprn","value":"","disabled":true},{"key":"created_since","value":"","type":"text","disabled":true},{"key":"created_before","value":"","type":"text","disabled":true},{"key":"updated_since","value":"","type":"text","disabled":true},{"key":"updated_before","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"material_number\": \"MAT-001\",\n \"compliance_stream\": \"Asbestos\",\n \"material_type\": \"Other\",\n \"material_status\": \"ACTIVE\",\n \"location\": \"Ground Floor / Cupboard\",\n \"sitemap_coordinates\": null,\n \"property_id\": 123456,\n \"values\": {\n \"data_point_key_1\": \"value_1\",\n \"data_point_key_2\": \"value_2\",\n \"data_point_key_3\": \"value_3\"\n },\n \"next_due_date\": \"2025-02-03\",\n \"created_at\": \"2024-02-20 13:43:24\",\n \"updated_at\": \"2026-02-05 09:18:05\"\n },\n {\n \"id\": 123457,\n \"material_number\": \"MAT-002\",\n \"compliance_stream\": \"Asbestos\",\n \"material_type\": \"Other\",\n \"material_status\": \"ACTIVE\",\n \"location\": \"Ground Floor / Cupboard\",\n \"sitemap_coordinates\": null,\n \"property_id\": 123457,\n \"values\": {\n \"data_point_key_1\": \"value_1\",\n \"data_point_key_2\": \"value_2\",\n \"data_point_key_3\": \"value_3\"\n },\n \"next_due_date\": \"2025-02-03\",\n \"created_at\": \"2024-02-20 13:43:24\",\n \"updated_at\": \"2026-02-05 09:18:05\"\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/material?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/material?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/material?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/material\",\n \"per_page\": \"1\",\n \"to\": 1\n }\n}"}],"_postman_id":"46d6fffe-13a2-4372-b9b2-5fd38de6b4e9"},{"name":"Get Material","event":[{"listen":"test","script":{"id":"f78128a7-f35d-43fa-8184-ede8fbf00d36","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3cb12cb6-60aa-4150-94c2-3e54685b6a35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}material/{{material_id}}","description":"Retrieves a single material by its unique identifier.
\nEndpoint: GET {{public_api_v2_domain}}material/{{material_id}}
Authentication: Requires a valid API key passed via the api-key request header.
material_id path variable must correspond to an existing material. If the material is not found, a 404 response will be returned.shallow to true to reduce response payload size by omitting nested relationship data.Updates an existing material record by its unique identifier. Only the fields provided in the request body will be updated.
\nEndpoint: PATCH {{public_api_v2_domain}}material/{{material_id}}
Authentication: Requires a valid API key passed via the api-key request header.
The request body must be sent as JSON. All fields are optional — include only the fields you wish to update.
\nReturns a 200 OK on success.
compliance_stream can be retrieved by calling GET library/compliance-streams.Retrieve a paginated list of notifications for the authenticated user or organisation.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a paginated list of notification objects matching the specified filters.
\n","urlObject":{"host":["{{public_api_v2_domain}}notification"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"description":{"content":"Comma separated list of notification types. You can find these by calling GET library/notification-types
\n","type":"text/plain"},"key":"notification_type","value":""},{"disabled":true,"key":"created_since","value":""},{"disabled":true,"key":"created_before","value":""},{"disabled":true,"key":"updated_since","value":""},{"disabled":true,"key":"updated_before","value":""}],"variable":[]}},"response":[{"id":"ecef740e-b38e-4095-9b18-da1b717b18bf","name":"Get Notifications","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{public_api_v2_domain}}notification","host":["{{public_api_v2_domain}}notification"],"query":[{"key":"limit","value":"10","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"notification_type","value":"","description":"Comma separated list of notification types. You can find these by calling GET library/notification-types","disabled":true},{"key":"created_since","value":"","type":"text","disabled":true},{"key":"created_before","value":"","type":"text","disabled":true},{"key":"updated_since","value":"","type":"text","disabled":true},{"key":"updated_before","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"title\": \"Duplicate Certificate Loaded\",\n \"message\": \"The document ID: 123456 already exists in the system.\",\n \"read\": false,\n \"document_id\": 123456,\n \"notification_type\": \"Duplicate Document\",\n \"created_at\": \"2022-12-15 13:04:30\",\n \"updated_at\": \"2022-12-15 13:04:30\"\n },\n {\n \"id\": 123457,\n \"title\": \"Duplicate Document\",\n \"message\": \"The document ID: 123457 already exists in the system.\",\n \"read\": true,\n \"document_id\": 123457,\n \"notification_type\": \"Duplicate Document\",\n \"created_at\": \"2022-11-24 10:54:39\",\n \"updated_at\": \"2022-11-30 11:38:37\"\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/notification?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/notification?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/notification?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/notification\",\n \"per_page\": \"2\",\n \"to\": 2\n }\n}"}],"_postman_id":"69523302-bda8-4f44-9072-28eb3312c836"},{"name":"Get Notification","event":[{"listen":"test","script":{"id":"cc3a7430-ca9d-46c1-aa20-81a15dfaee32","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c83fa557-6cf7-45d1-9bf2-924247e8dce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}notification/{{notification_id}}","description":"Retrieve a single notification by its unique identifier.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a notification object matching the provided notification_id.
Retrieves a paginated list of units from the True Compliance API. Units represent individual properties or sub-properties (e.g. flats within a building) and can be filtered by various criteria including property type, parent property, UPRN, and date ranges.
\nThis request requires an API key. The key is read from the {{api-key}} variable and should be set in your active environment before sending the request.
Returns a paginated list of unit objects matching the specified filters. The response includes pagination metadata (such as total count, current page, and page size) alongside the array of unit records.
\n","urlObject":{"host":["{{public_api_v2_domain}}unit"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"description":{"content":"Comma separated list of property types. You can find these by calling GET library/property-types
\n","type":"text/plain"},"key":"property_type","value":"House,Flat"},{"disabled":true,"key":"parent_property_id","value":""},{"disabled":true,"key":"parent_property_uprn","value":""},{"disabled":true,"key":"uprn","value":""},{"disabled":true,"key":"created_since","value":""},{"disabled":true,"key":"created_before","value":""},{"disabled":true,"key":"updated_since","value":""},{"disabled":true,"key":"updated_before","value":""},{"description":{"content":"Single flag name
\n","type":"text/plain"},"key":"flag","value":null}],"variable":[]}},"response":[{"id":"f971aa17-6919-434e-91f3-4146b5c4ddcb","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true}],"url":{"raw":"{{public_api_v2_domain}}unit","host":["{{public_api_v2_domain}}unit"],"query":[{"key":"limit","value":"10","disabled":true},{"key":"page","value":"1","type":"text","disabled":true},{"key":"property_type","value":"House,Flat","description":"Comma separated list of property types. You can find these by calling GET library/property-types","type":"text","disabled":true},{"key":"parent_property_id","value":"","type":"text","disabled":true},{"key":"parent_property_uprn","value":"","disabled":true},{"key":"uprn","value":"","disabled":true},{"key":"created_since","value":"","type":"text","disabled":true},{"key":"created_before","value":"","type":"text","disabled":true},{"key":"updated_since","value":"","type":"text","disabled":true},{"key":"updated_before","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123456,\n \"uprn\": \"ABC123\",\n \"address_1\": \"1 Main Road\",\n \"address_2\": \"\",\n \"town\": \"London\",\n \"county\": \"\",\n \"postcode\": \"AB1 2CD\",\n \"resident\": \"\",\n \"updated_at\": \"2024-06-01 01:00:58\",\n \"address\": \"1 Main Road, London, AB1 2CD\",\n \"property_type\": \"Residence\",\n \"parent_property_id\": null,\n \"parent_parent_uprn\": null,\n \"property_data\": {\n \"block_code\": \"ABC123\",\n \"contractor_contract\": \"FEJ3\",\n \"housing_officer_name\": \"Mary Test\",\n ...\n },\n \"compliance_statuses\": [\n {\n \"stream_name\": \"Electrical\",\n \"methodology\": \"Standard TC Compliance\",\n \"compliant\": false,\n \"non_compliant_reason\": \"not-in-date\",\n \"certificate_used\": 123456,\n \"certificate_filename\": \"test-eicr.pdf\",\n \"certificate_contractor\": \"Various\",\n \"certificate_number\": \"123456\",\n \"last_checked_date\": \"2019-05-31T00:00:00.000000Z\",\n \"next_due_date\": \"2024-05-31T00:00:00.000000Z\",\n \"created_at\": \"2020-11-13T16:27:26.000000Z\",\n \"certificate_created_at\": \"2020-11-13T16:23:32.000000Z\"\n }\n ],\n \"compliance_streams\": [\n \"Electrical\"\n ],\n \"flags\": []\n },\n {\n \"id\": 123457,\n \"uprn\": \"ABC124\",\n \"address_1\": \"2 Main Road\",\n \"address_2\": \"\",\n \"town\": \"London\",\n \"county\": \"\",\n \"postcode\": \"AB1 2CD\",\n \"resident\": \"\",\n \"updated_at\": \"2024-06-01 01:01:02\",\n \"address\": \"2 Main Road, London, AB1 2CD\",\n \"property_type\": \"Residence\",\n \"parent_property_id\": null,\n \"parent_parent_uprn\": null,\n \"property_data\": {\n \"block_code\": \"ABC124\",\n \"contractor_contract\": \"PO9\",\n \"housing_officer_name\": \"Geoff Test\",\n ...\n },\n \"compliance_statuses\": [\n {\n \"stream_name\": \"Gas\",\n \"methodology\": \"Standard TC Compliance\",\n \"compliant\": false,\n \"non_compliant_reason\": \"not-in-date\",\n \"certificate_used\": 123458,\n \"certificate_filename\": \"test-lgsr.pdf\",\n \"certificate_contractor\": \"Test Contractore\",\n \"certificate_number\": \"123458\",\n \"last_checked_date\": \"2022-05-04T00:00:00.000000Z\",\n \"next_due_date\": \"2023-05-04T00:00:00.000000Z\",\n \"created_at\": null,\n \"certificate_created_at\": \"2022-05-06T06:01:11.000000Z\"\n },\n {\n \"stream_name\": \"Electrical\",\n \"methodology\": \"Standard TC Compliance\",\n \"compliant\": false,\n \"non_compliant_reason\": \"not-in-date\",\n \"certificate_used\": 123459,\n \"certificate_filename\": \"test-eicr.pdf\",\n \"certificate_contractor\": \"Test Contractore\",\n \"certificate_number\": \"123459\",\n \"last_checked_date\": \"2019-05-31T00:00:00.000000Z\",\n \"next_due_date\": \"2024-05-31T00:00:00.000000Z\",\n \"created_at\": null,\n \"certificate_created_at\": \"2020-11-13T16:24:03.000000Z\"\n }\n ],\n \"compliance_streams\": [\n \"Gas\",\n \"Electrical\"\n ],\n \"flags\": []\n }\n ],\n \"links\": {\n \"first\": \"https://{{api-domain}}/api/v2/unit?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"https://{{api-domain}}/api/v2/unit?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"current_page_url\": \"https://{{api-domain}}/api/v2/unit?page=1\",\n \"from\": 1,\n \"path\": \"https://{{api-domain}}/api/v2/unit\",\n \"per_page\": \"2\",\n \"to\": 2\n }\n}"}],"_postman_id":"9df32262-fed4-44a2-9f37-1054e1e6100c"},{"name":"Get Unit","event":[{"listen":"test","script":{"id":"c06e1408-770f-4393-acaa-252a41aee381","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"df81c88c-814b-450f-8cc7-f7ed77763074","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{public_api_v2_domain}}unit/{{unit_id}}","description":"Retrieves a single unit by its unique identifier.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a unit object matching the provided unit_id.
Creates a new unit (property) in the True Compliance system.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nThe request body must be sent as JSON.
\nReturns the created unit object on success.
\nPartially updates an existing unit (property) in the True Compliance system. Only the fields provided in the request body will be updated.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nThe request body must be sent as JSON. All fields are optional — only include the fields you wish to update.
\nReturns the updated unit object on success.
\nPermanently deletes a single unit by its unique identifier.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a 200 OK on success.
Restores a previously deleted unit by its unique identifier, making it active in the True Compliance system again.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a 200 OK on success.
Uploads a supporting document to a specific unit (property).
\nThe request body must be sent as multipart/form-data.
This endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\n\nReturns a 200 OK on success.
compliance_stream:GET library/compliance-streamsAdds a flag to a specific unit (property). Flags can be used to mark a unit with a named label and an optional expiry date, useful for compliance tracking or status indicators.
\nThe request body must be sent as JSON (application/json).
{\n \"flag_name\": \"Example flag name\",\n \"expiry_date\": \"2026-03-02\"\n}\nThis request inherits its authentication configuration from the parent collection. Ensure the collection-level auth credentials are set correctly before sending this request.
\n","urlObject":{"path":["{{property_id}}","flag"],"host":["{{public_api_v2_domain}}unit"],"query":[],"variable":[]}},"response":[],"_postman_id":"16b725ca-e2fa-4708-8a61-42ed0aaa42e1"},{"name":"Remove Flag","id":"c6e10a89-fb5c-47e5-8267-e78f2a0977ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"flag_name\": \"Example flag name\"\n}","options":{"raw":{"language":"json"}}},"url":"{{public_api_v2_domain}}unit/{{property_id}}/flag","description":"Removes a flag from a specific Unit.
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
Flags: Use the library endpoint to retrieve all valid values for flag_name:
GET library/flagsAdds new data properties or updates existing ones on a specific unit.
\nMethod: PATCH
URL: {{public_api_v2_domain}}unit/{{unit_id}}/data
A JSON object where each key-value pair represents a data property to add or update on the unit.
\n{\n \"new-property-data-key\": \"new-property-data-value\",\n \"existing-property-data-key\": \"updated-property-data-value\"\n}\n\nExisting properties included in the request body will be updated with the new value.
\nNew properties included in the request body will be added to the unit.
\nProperties not included in the request body are left unchanged.
\nAdds a compliance stream to a specific Unit.
\nThe request body must be sent as JSON.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a 200 OK on success.
compliance_stream:GET library/compliance-streamsRemoves a compliance stream from a specific Unit.
\nThe request body must be sent as JSON.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\nReturns a 200 OK on success.
compliance_stream:GET library/compliance-streamsUpdates the status of a specific Fault.
\nThe request body must be sent as JSON.
\nReturns a 200 OK on success.
fault_status:GET library/fault-statusesFile. Optional. 1mb max filesize.
\n","type":"file","uuid":"69637232-271e-41c3-844b-74501672cf24","value":null}]},"url":"{{public_api_v2_domain}}fault/{{fault_id}}/note","description":"Adds a note to a specific Fault, with an optional file attachment.
\nThe request body must be sent as multipart/form-data.
Returns a 200 OK on success.
Retrieves the latest report for a given organisation or property, identified by its unique slug.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\n\nReturns the latest report object on success.
\nRetrieves the latest report for a specific tab within a given organisation or property, identified by its unique slug and tab name.
\nThis endpoint requires a Bearer token. Pass your API key using the Authorization header:
Authorization: Bearer {{api-key}}\n\nReturns the latest report object for the specified tab on success.
\n