{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.worxsafety.com.au" } ], "info": { "name": "WorxSafety API Documentation", "_postman_id": "18df6537-c209-4515-acc1-066edd63eb6f", "description": "WorxSafety API for managing inductees, contractors, assets, projects, inductions, documents, and more.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Inductees", "description": "\nAPIs for managing inductees (workers\/employees).\n\nInductees are individual workers registered in the system. Use these endpoints\nto list, create, update, and manage worker records.", "item": [ { "name": "List all direct inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/index", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all direct inductees (workers not associated with a contractor) for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List all inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/index\/all", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/index\/all" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all inductees (both direct and contractor-associated)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List inactive inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/index\/inactive", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/index\/inactive" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all inactive inductees." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List subcontracted inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/index\/subcontracted", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/index\/subcontracted" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all inductees associated with contractors." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List approved inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/index\/approved", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/index\/approved" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all approved inductees." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List revoked inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/index\/revoked", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/index\/revoked" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all revoked\/unapproved inductees." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent inductee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/recent", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created inductee." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Search inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/search\/:search", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/search\/:search", "variable": [ { "id": "search", "key": "search", "value": "john", "description": "Search term (name, email, or ID)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for inductees by name, email, or ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get inductee details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information for a specific inductee." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Test endpoint", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/test", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/test" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns sample inductee data for testing API integration." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get inductee inductions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/inductions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/inductions\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all induction records for a specific inductee." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get inductee training", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/training\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/training\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all training records for a specific inductee." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get inductee documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all documents for a specific inductee." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get inductee issues", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/issues\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/issues\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all issues related to a specific inductee." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create inductee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/create", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Smith\",\"email\":\"john@example.com\",\"active\":1,\"approved\":1,\"role\":\"user\",\"phone\":\"0244556677\",\"mobile\":\"0412345678\",\"emergencyContact\":\"Jane Smith\",\"emergencyPhone\":\"0498765432\",\"workType\":1,\"residency\":\"architecto\",\"residencyDetails\":\"architecto\",\"residencyExpiry\":\"architecto\",\"dob\":\"1990-01-15\"}" }, "description": "Create a new inductee record." }, "response": [] }, { "name": "Update inductee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/update\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/update\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"email\":\"gbailey@example.net\",\"active\":16,\"approved\":16,\"role\":\"architecto\",\"revokeReason\":\"architecto\",\"phone\":\"architecto\",\"mobile\":\"architecto\",\"emergencyContact\":\"architecto\",\"emergencyPhone\":\"architecto\",\"workType\":16,\"residency\":\"S\",\"residencyDetails\":\"America\\\/Bahia_Banderas\",\"residencyExpiry\":\"2026-03-03\",\"dob\":\"architecto\"}" }, "description": "Update an existing inductee's information." }, "response": [] }, { "name": "Disable inductee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inductee\/disable\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inductee\/disable\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The user ID of the inductee." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Disable\/revoke an inductee account." }, "response": [] } ] }, { "name": "Contractors", "description": "\nAPIs for managing contractor companies and their workers.\n\nContractors are external companies that provide workers to your organization.\nUse these endpoints to list contractors, view their workers, and manage contractor relationships.", "item": [ { "name": "List all contractors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/index", "query": [], "raw": "{{baseUrl}}\/api\/contractor\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all contractor companies associated with your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List approved contractors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/index\/approved", "query": [], "raw": "{{baseUrl}}\/api\/contractor\/index\/approved" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all approved contractor companies." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List revoked contractors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/index\/revoked", "query": [], "raw": "{{baseUrl}}\/api\/contractor\/index\/revoked" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all revoked\/unapproved contractor companies." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get contractor by ABN", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/abn", "query": [], "raw": "{{baseUrl}}\/api\/contractor\/abn" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"abn\":\"12345678901\"}" }, "description": "Find a contractor company by their ABN (Australian Business Number)." }, "response": [] }, { "name": "Get contractor details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/contractor\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "456", "description": "The contractor ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information for a specific contractor company." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get contractor's inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/show\/:id\/inductee", "query": [], "raw": "{{baseUrl}}\/api\/contractor\/show\/:id\/inductee", "variable": [ { "id": "id", "key": "id", "value": "456", "description": "The contractor ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all workers\/inductees for a specific contractor company." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Search contractors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contractor\/search", "query": [ { "key": "search", "value": "MGN+Projects", "description": "The search term. Searches contractor name (partial match) or email (exact match).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/contractor\/search?search=MGN+Projects" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for contractor companies by name or email.\nName search uses partial matching (e.g., \"MGN\" finds \"MGN Projects Pty Ltd\").\nEmail search uses exact matching." }, "response": [ { "header": [], "code": 200, "body": "{\"count\": 1, \"data\": [{\"id\": 14, \"name\": \"MGN Projects Pty Ltd\", \"email\": \"glen@mgnprojects.com.au\", \"active\": 1}]}", "name": "" } ] } ] }, { "name": "Assets", "description": "\nAPIs for managing assets (plant, equipment, vehicles).\n\nAssets include machinery, vehicles, tools, and other equipment that require tracking,\nmaintenance records, and compliance documentation.", "item": [ { "name": "List all assets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/index", "query": [], "raw": "{{baseUrl}}\/api\/asset\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all assets for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Search assets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/search\/:search", "query": [], "raw": "{{baseUrl}}\/api\/asset\/search\/:search", "variable": [ { "id": "search", "key": "search", "value": "toyota", "description": "Search term." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for assets by make, model, or ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get asset details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The asset ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information for a specific asset." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Test endpoint", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/test", "query": [], "raw": "{{baseUrl}}\/api\/asset\/test" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns sample asset data for testing API integration." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent asset", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/recent", "query": [], "raw": "{{baseUrl}}\/api\/asset\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created asset." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get asset documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The asset ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all documents for a specific asset." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get asset prestarts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/prestarts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/prestarts\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The asset ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns prestart check records for a specific asset." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get asset service records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/maintenance\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/maintenance\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The asset ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns maintenance\/service records for a specific asset." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create asset", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/create", "query": [], "raw": "{{baseUrl}}\/api\/asset\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"make\":\"Toyota\",\"model\":\"Hilux\",\"serialNumber\":\"architecto\",\"registration\":\"architecto\",\"location\":\"architecto\",\"approver\":16,\"meterType\":\"KM\",\"serviceInterval\":16,\"serviceIntervalRead\":16,\"serviceDueRead\":16}" }, "description": "Create a new asset record." }, "response": [] }, { "name": "Create asset service item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/item\/create", "query": [], "raw": "{{baseUrl}}\/api\/asset\/item\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"assetId\":123,\"itemName\":\"Oil Filter\",\"meterType\":\"KM\",\"meterReading\":50000,\"serviceInterval\":10000,\"nextInterval\":60000,\"serviceFrequency\":12,\"nextFrequency\":\"2024-12-01\"}" }, "description": "Add a service item to an existing asset." }, "response": [] }, { "name": "Update asset service item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/item\/update\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/item\/update\/:id", "variable": [ { "id": "id", "key": "id", "value": "456", "description": "The service item ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"itemName\":\"S\",\"meterType\":\"N\\\/A\",\"meterReading\":16,\"serviceInterval\":16,\"nextInterval\":16,\"serviceFrequency\":16}" }, "description": "Update an existing asset service item." }, "response": [] }, { "name": "Update asset", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/update\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/update\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The asset ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"make\":\"S\",\"model\":\"S\",\"serialNumber\":\"S\",\"registration\":\"S\",\"location\":\"S\",\"approver\":16,\"meterType\":\"KM\",\"meterRead\":16,\"serviceInterval\":16,\"serviceIntervalRead\":16,\"serviceDueRead\":16}" }, "description": "Update an existing asset's information." }, "response": [] }, { "name": "Delete asset", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/asset\/disable\/:id", "query": [], "raw": "{{baseUrl}}\/api\/asset\/disable\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The asset ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an asset record." }, "response": [] } ] }, { "name": "Projects", "description": "\nAPIs for managing projects (work sites\/locations).\n\nProjects represent physical work locations including address, contacts,\nand associated workers\/contractors.", "item": [ { "name": "List all projects", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/index", "query": [], "raw": "{{baseUrl}}\/api\/project\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all projects for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Search projects", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/search\/:search", "query": [], "raw": "{{baseUrl}}\/api\/project\/search\/:search", "variable": [ { "id": "search", "key": "search", "value": "construction", "description": "Search term." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for projects by name or ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/recent", "query": [], "raw": "{{baseUrl}}\/api\/project\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created project." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get project details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/project\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The project ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information for a specific project." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get recent SWMS PDF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/swms\/pdf\/recent", "query": [], "raw": "{{baseUrl}}\/api\/project\/swms\/pdf\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a download URL for the most recent approved SWMS PDF." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get recent form submission PDF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/form_submission\/pdf\/recent", "query": [], "raw": "{{baseUrl}}\/api\/project\/form_submission\/pdf\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a download URL for the most recent form submission PDF." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/create", "query": [], "raw": "{{baseUrl}}\/api\/project\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Main Street Construction\",\"street\":\"123 Main Street\",\"suburb\":\"Sydney\",\"state\":\"NSW\",\"phone\":\"0244556677\",\"manager\":\"John Smith\",\"contractors\":\"1,2,3\"}" }, "description": "Create a new project\/work site." }, "response": [] }, { "name": "Update project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project\/update\/:id", "query": [], "raw": "{{baseUrl}}\/api\/project\/update\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The project ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"street\":\"architecto\",\"suburb\":\"n\",\"state\":\"g\",\"phone\":\"z\",\"manager\":\"m\",\"contractors\":\"architecto\"}" }, "description": "Update an existing project's information." }, "response": [] } ] }, { "name": "Project Events", "description": "\nAPIs for managing project site events and activity tracking.\n\nTrack site sign-ins, sign-outs, and other project-related events.", "item": [ { "name": "List all project events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project_events\/all", "query": [], "raw": "{{baseUrl}}\/api\/project_events\/all" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all project events across all projects for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get project events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project_events\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/project_events\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The project ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all events for a specific project." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Remove the specified resource from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project_events\/search", "query": [], "raw": "{{baseUrl}}\/api\/project_events\/search" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Inductions & Training", "description": "\nAPIs for managing inductions, training programs, and site-specific inductions.\n\nTrack completion status, expiry dates, and enrollment records for safety training\nand induction programs.", "item": [ { "name": "List all inductions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/induction\/index", "query": [], "raw": "{{baseUrl}}\/api\/induction\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all induction programs for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List all training programs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/training\/index", "query": [], "raw": "{{baseUrl}}\/api\/training\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all training programs for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List site inductions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/site_induction\/index", "query": [], "raw": "{{baseUrl}}\/api\/site_induction\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all site-specific induction programs for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent induction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/induction\/recent", "query": [], "raw": "{{baseUrl}}\/api\/induction\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created induction." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent training", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/training\/recent", "query": [], "raw": "{{baseUrl}}\/api\/training\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created training program." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get induction records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/induction\/records\/:id", "query": [], "raw": "{{baseUrl}}\/api\/induction\/records\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The induction ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all records for a specific induction program." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get training records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/training\/records\/:id", "query": [], "raw": "{{baseUrl}}\/api\/training\/records\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The training\/induction ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all records for a specific training program." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get site induction records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/site_induction\/records\/:id", "query": [], "raw": "{{baseUrl}}\/api\/site_induction\/records\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The site induction ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all records for a specific site induction program." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Documents", "description": "\nAPIs for managing documents and compliance records.\n\nTrack document expiry, validity status, and ownership across workers, assets,\nprojects, and contractor companies.", "item": [ { "name": "List all documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/index", "query": [], "raw": "{{baseUrl}}\/api\/documents\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all documents with expiry dates for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List valid documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/index\/valid", "query": [], "raw": "{{baseUrl}}\/api\/documents\/index\/valid" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all documents that are currently valid (not expired or expiring soon)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List expired documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/index\/expired", "query": [], "raw": "{{baseUrl}}\/api\/documents\/index\/expired" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all documents that have already expired." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List expiring documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/index\/expiring", "query": [], "raw": "{{baseUrl}}\/api\/documents\/index\/expiring" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all documents expiring within the next 10 days." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Issues", "description": "\nAPIs for managing safety, quality, and operational issues.\n\nIssues can be related to workers, assets, projects, or contractor companies.\nTrack acknowledgment, actions, and resolution of workplace issues.", "item": [ { "name": "List all issues", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue\/index", "query": [], "raw": "{{baseUrl}}\/api\/issue\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all issues for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent issue", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue\/recent", "query": [], "raw": "{{baseUrl}}\/api\/issue\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created issue." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Search issues", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue\/search\/:search", "query": [], "raw": "{{baseUrl}}\/api\/issue\/search\/:search", "variable": [ { "id": "search", "key": "search", "value": "safety", "description": "Search term." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for issues by description or ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get issue details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/issue\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The issue ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information for a specific issue." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Test endpoint", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue\/test", "query": [], "raw": "{{baseUrl}}\/api\/issue\/test" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns sample issue data for testing API integration." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create issue", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue\/create", "query": [], "raw": "{{baseUrl}}\/api\/issue\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ownerId\":123,\"issueType\":\"Safety\",\"relationType\":\"Project\",\"relationId\":456,\"description\":\"Fire extinguisher needs inspection\",\"dueDate\":\"2024-12-31\",\"priority\":\"High\"}" }, "description": "Create a new issue record." }, "response": [] } ] }, { "name": "Subscriptions", "description": "\nAPIs for managing webhook subscriptions.\n\nSubscribe to events and receive webhook notifications when data changes occur.", "item": [ { "name": "List all subscriptions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/index", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all webhook subscriptions for your API token." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/create", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"hookUrl\":\"https:\\\/\\\/example.com\\\/webhook\",\"event\":\"inductee.created\"}" }, "description": "Create a new webhook subscription." }, "response": [] }, { "name": "Delete subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subscription\/delete", "query": [], "raw": "{{baseUrl}}\/api\/subscription\/delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"hookUrl\":\"https:\\\/\\\/example.com\\\/webhook\"}" }, "description": "Delete a webhook subscription by URL." }, "response": [] } ] }, { "name": "", "description": "", "item": [ { "name": "POST api\/app_login_passkey", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/app_login_passkey", "query": [], "raw": "{{baseUrl}}\/api\/app_login_passkey" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_authentication_response\":\"architecto\",\"challengeId\":\"architecto\",\"device_name\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/issue_passkey_challenge", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/issue_passkey_challenge", "query": [], "raw": "{{baseUrl}}\/api\/issue_passkey_challenge" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"challenge\":\"{\\\"challenge\\\":\\\"DaqPslvh91yE5t6w2skzFjkoRbn0VbhmpLJzDxjk_sk\\\",\\\"rpId\\\":\\\"app.worxsafety.com.au\\\",\\\"allowCredentials\\\":[]}\",\"chalId\":\"fffc28dd-edd3-4478-b821-fd2bdccbac5b\"}", "name": "" } ] }, { "name": "GET api\/form\/{slug}\/{id}\/{file}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/form\/:slug\/:id\/:file", "query": [], "raw": "{{baseUrl}}\/api\/form\/:slug\/:id\/:file", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the form." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the {slug}." }, { "id": "file", "key": "file", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\n \"message\": \"\"\n}", "name": "" } ] }, { "name": "GET api\/form\/{slug}\/{id}\/{name}\/get", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/form\/:slug\/:id\/:name\/get", "query": [], "raw": "{{baseUrl}}\/api\/form\/:slug\/:id\/:name\/get", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the form." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the {slug}." }, { "id": "name", "key": "name", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\n \"message\": \"\"\n}", "name": "" } ] }, { "name": "POST api\/store_fcm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/store_fcm", "query": [], "raw": "{{baseUrl}}\/api\/store_fcm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fcmToken\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/logout_device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/logout_device", "query": [], "raw": "{{baseUrl}}\/api\/logout_device" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fcmToken\":\"architecto\"}" }, "description": "" }, "response": [] } ] }, { "name": "Registers", "description": "\nAPIs for managing registers (Risk Registers, WHS Registers, etc.).\n\nRegisters are configurable data tables that can be used for tracking various\ntypes of information including Company Risk Registers, Operational WHS Risk Registers,\nand other compliance data.", "item": [ { "name": "List all registers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/index", "query": [], "raw": "{{baseUrl}}\/api\/register\/index" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all registers for your client, including Company Risk Register and Operational WHS Risk Register." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Search registers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/search\/:search", "query": [], "raw": "{{baseUrl}}\/api\/register\/search\/:search", "variable": [ { "id": "search", "key": "search", "value": "Risk", "description": "Search term." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for registers by name." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/recent", "query": [], "raw": "{{baseUrl}}\/api\/register\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created register for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get most recent register entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/entry\/recent", "query": [], "raw": "{{baseUrl}}\/api\/register\/entry\/recent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the most recently created register entry across all registers for your client." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get register details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/show\/:id", "query": [], "raw": "{{baseUrl}}\/api\/register\/show\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The register ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information for a specific register including its column definitions." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get register entries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/entries\/:id", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "perPage", "value": "50", "description": "Number of entries per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/register\/entries\/:id?page=1&perPage=50", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The register ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all entries for a specific register. This is the data stored in the register." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get single entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/:registerId\/entry\/:entryId", "query": [], "raw": "{{baseUrl}}\/api\/register\/:registerId\/entry\/:entryId", "variable": [ { "id": "registerId", "key": "registerId", "value": "1", "description": "The register ID." }, { "id": "entryId", "key": "entryId", "value": "123", "description": "The entry ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a single register entry by ID." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get entry files", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/:registerId\/entry\/:entryId\/files", "query": [], "raw": "{{baseUrl}}\/api\/register\/:registerId\/entry\/:entryId\/files", "variable": [ { "id": "registerId", "key": "registerId", "value": "1", "description": "The register ID." }, { "id": "entryId", "key": "entryId", "value": "123", "description": "The entry ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all files attached to a specific register entry row." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Download entry file", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/:registerId\/document\/:documentId\/download", "query": [], "raw": "{{baseUrl}}\/api\/register\/:registerId\/document\/:documentId\/download", "variable": [ { "id": "registerId", "key": "registerId", "value": "1", "description": "The register ID." }, { "id": "documentId", "key": "documentId", "value": "456", "description": "The document ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Download a file from a register entry using only register and document IDs." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get entry file download URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register\/:registerId\/document\/:documentId\/download_url", "query": [], "raw": "{{baseUrl}}\/api\/register\/:registerId\/document\/:documentId\/download_url", "variable": [ { "id": "registerId", "key": "registerId", "value": "1", "description": "The register ID." }, { "id": "documentId", "key": "documentId", "value": "456", "description": "The document ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a temporary download URL for a file from a register entry.\nThe URL is valid for 2 hours." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Synchronise Inductees", "description": "\nAPIs for managing mass assignement of (workers\/employees).\n\nInductees are individual workers registered in the system. This endpoint is useful for syncronising \ndata to maintain an accurate employee list. It only works for direct employees.", "item": [ { "name": "Synchronise Inductees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/sync", "query": [], "raw": "{{baseUrl}}\/api\/users\/sync" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[[\"A Name\",\"an@email.com\",\"0400000000\"],[\"Another Name\",\"another@email.com\",\"0400000000\"]]}" }, "description": "Synchronises the list of inductees (workers) for the authenticated client.\nUsers present in the payload but not yet in the system will be created and\nassigned an account. Users already in the system will be reactivated if\ninactive. Users **not** present in the payload will be deactivated." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Users Synchronised Successfully.\"\n}", "name": "Success" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }