{ "info": { "name": "KATSANA API V1", "description": "KATSANA API V1 request examples. Add your credentials before sending requests and keep them out of shared files. Review each operation: some change data, send notifications or create payment transactions.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.katsana.com" }, { "key": "access_token", "value": "" }, { "key": "password", "value": "" } ], "item": [ { "name": "Authentication", "item": [ { "name": "Sign in and get a token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Sign in with your account email as username and your password in a JSON body. The email alias is also accepted. A successful response fills the API token field in this reference automatically; protected requests then send that token in the Authorization header. Send both credentials; missing values are not consistently validated. See the [authentication guide](/guides/authentication/) for token handling and browser request availability.", "url": { "raw": "{{base_url}}/auth", "host": [ "{{base_url}}" ], "path": [ "auth" ], "variable": [] }, "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"{{password}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Account", "item": [ { "name": "Get your profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/profile", "host": [ "{{base_url}}" ], "path": [ "profile" ], "variable": [], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: fleets, plan, company, operations_subscription." } ] } }, "response": [] }, { "name": "Update your profile", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Only supplied fields are updated. Supplied fullname/address/state/country/contact fields may not be empty; phone values use platform phone validation. This operation changes data.", "url": { "raw": "{{base_url}}/profile", "host": [ "{{base_url}}" ], "path": [ "profile" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"fullname\": \"Example Developer\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Upload your avatar", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Uploads a new profile avatar.", "url": { "raw": "{{base_url}}/profile/avatar", "host": [ "{{base_url}}" ], "path": [ "profile", "avatar" ], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Choose your own local image before sending.", "disabled": false } ] } }, "response": [] } ] }, { "name": "Vehicles", "item": [ { "name": "Upload vehicle avatar", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Uploads a new vehicle avatar.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/avatar", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "avatar" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Choose your own local image before sending.", "disabled": false } ] } }, "response": [] }, { "name": "List accessible vehicles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/vehicles", "host": [ "{{base_url}}" ], "path": [ "vehicles" ], "variable": [], "query": [ { "key": "page", "value": "1", "disabled": true, "description": "Supplying page enables pagination. Without it, all accessible records are returned." }, { "key": "per_page", "value": "100", "disabled": true, "description": "Page size, used only when page is supplied. No universal maximum is established." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: fleets, tags, features, score, movement, temperature, online, addons, regulation, drivemark." } ] } }, "response": [] }, { "name": "Get a vehicle", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/vehicles/:vehicle", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: fleets, tags, features, score, movement, temperature, online, addons, regulation, drivemark." } ] } }, "response": [] }, { "name": "Update a vehicle", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires vehicle update permission. license_plate takes precedence over the legacy vehicle_number field. Updating manufacturer/model can update description when no explicit description is provided. This operation changes data.", "url": { "raw": "{{base_url}}/vehicles/:vehicle", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Example vehicle\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get vehicle tracker and SIM information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Returns tracker and SIM provider fields for a vehicle the account can view. Keep device and SIM identifiers private. Field types and nullability are not fully specified; handle the returned values without assuming fixed provider casts.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/beacon", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "beacon" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] } ] }, { "name": "Locations", "item": [ { "name": "Get current vehicle location", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Private no-cache response. Data comes from the current tracking provider.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/location", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "location" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] } ] }, { "name": "Fleets", "item": [ { "name": "List accessible fleets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/fleets", "host": [ "{{base_url}}" ], "path": [ "fleets" ], "variable": [], "query": [ { "key": "page", "value": "1", "disabled": true, "description": "Supplying page enables pagination. Without it, all accessible records are returned." }, { "key": "per_page", "value": "100", "disabled": true, "description": "Page size, used only when page is supplied. No universal maximum is established." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: managers." } ] } }, "response": [] }, { "name": "Get a fleet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/fleets/:fleet", "host": [ "{{base_url}}" ], "path": [ "fleets", ":fleet" ], "variable": [ { "key": "fleet", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: managers." } ] } }, "response": [] }, { "name": "List drivers in a fleet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/fleets/:fleet/drivers", "host": [ "{{base_url}}" ], "path": [ "fleets", ":fleet", "drivers" ], "variable": [ { "key": "fleet", "value": "1001" } ], "query": [ { "key": "page", "value": "1", "disabled": true, "description": "Supplying page enables pagination. Without it, all accessible records are returned." }, { "key": "per_page", "value": "100", "disabled": true, "description": "Page size, used only when page is supplied. No universal maximum is established." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: fleet_id, profile." } ] } }, "response": [] }, { "name": "Create a fleet driver", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires fleet update permission. identification_type defaults to mykad. Do not send biometric data from a public documentation client. This operation changes data.", "url": { "raw": "{{base_url}}/fleets/:fleet/drivers", "host": [ "{{base_url}}" ], "path": [ "fleets", ":fleet", "drivers" ], "variable": [ { "key": "fleet", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"fullname\": \"Example Driver\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List vehicles in a fleet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/fleets/:fleet/vehicles", "host": [ "{{base_url}}" ], "path": [ "fleets", ":fleet", "vehicles" ], "variable": [ { "key": "fleet", "value": "1001" } ], "query": [ { "key": "page", "value": "1", "disabled": true, "description": "Supplying page enables pagination. Without it, all accessible records are returned." }, { "key": "per_page", "value": "100", "disabled": true, "description": "Page size, used only when page is supplied. No universal maximum is established." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: fleets, tags, features, score, movement, temperature, online, addons, regulation, drivemark." } ] } }, "response": [] }, { "name": "Update a fleet driver", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires fleet update permission. fullname remains required. An omitted identification is set to null by this implementation. PHP SDK v1.2.9 sends POST here; use PATCH directly until that SDK is corrected. This operation changes data.", "url": { "raw": "{{base_url}}/fleets/:fleet/drivers/:driver", "host": [ "{{base_url}}" ], "path": [ "fleets", ":fleet", "drivers", ":driver" ], "variable": [ { "key": "fleet", "value": "1001" }, { "key": "driver", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"fullname\": \"Example Driver\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Checkpoints", "item": [ { "name": "Get checkpoints · default", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Alias for today. Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/checkpoints", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "checkpoints" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Get checkpoints · today", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/checkpoints/today", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "checkpoints", "today" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Get checkpoints · yesterday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/checkpoints/yesterday", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "checkpoints", "yesterday" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Get checkpoints · range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. The supplied start is rounded to start of its day; the supplied end is rounded to start of its day plus one day.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/checkpoints/duration", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "checkpoints", "duration" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": false, "description": "Range start parsed in timezone (device timezone by default)." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": false, "description": "Range end parsed in timezone (device timezone by default)." }, { "key": "timezone", "value": "Asia/Kuala_Lumpur", "disabled": true, "description": "IANA timezone overriding the device timezone for range parsing." } ] } }, "response": [] }, { "name": "Get checkpoints · date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/checkpoints/:year/:month/:day", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "checkpoints", ":year", ":month", ":day" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" }, { "key": "day", "value": "15" } ] } }, "response": [] }, { "name": "Get checkpoints · month", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/checkpoints/:year/:month", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "checkpoints", ":year", ":month" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" } ] } }, "response": [] } ] }, { "name": "Positions", "item": [ { "name": "Get positions · default", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Alias for today. Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/positions", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "positions" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: speed, odometer, place, altitude, distance, course, fuel, ignition, temperature, voltage, connectivity, driver, harsh, custom, device_battery." } ] } }, "response": [] }, { "name": "Get positions · today", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/positions/today", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "positions", "today" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: speed, odometer, place, altitude, distance, course, fuel, ignition, temperature, voltage, connectivity, driver, harsh, custom, device_battery." } ] } }, "response": [] }, { "name": "Get positions · yesterday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/positions/yesterday", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "positions", "yesterday" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: speed, odometer, place, altitude, distance, course, fuel, ignition, temperature, voltage, connectivity, driver, harsh, custom, device_battery." } ] } }, "response": [] }, { "name": "Get positions · range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Rejects ranges whose diffInHours exceeds 24 with 416.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/positions/duration", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "positions", "duration" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": false, "description": "Range start parsed in timezone (device timezone by default)." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": false, "description": "Range end parsed in timezone (device timezone by default)." }, { "key": "timezone", "value": "Asia/Kuala_Lumpur", "disabled": true, "description": "IANA timezone overriding the device timezone for range parsing." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: speed, odometer, place, altitude, distance, course, fuel, ignition, temperature, voltage, connectivity, driver, harsh, custom, device_battery." } ] } }, "response": [] }, { "name": "Get positions · date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/positions/:year/:month/:day", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "positions", ":year", ":month", ":day" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" }, { "key": "day", "value": "15" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: speed, odometer, place, altitude, distance, course, fuel, ignition, temperature, voltage, connectivity, driver, harsh, custom, device_battery." } ] } }, "response": [] } ] }, { "name": "Daily summaries", "item": [ { "name": "Get daily summaries · default", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Alias for today. Calendar boundaries use the vehicle timezone. Single-day queries return a summary object or an empty array; month/range queries return an array.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/summaries", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "summaries" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: drivemark, violation_details, costing." } ] } }, "response": [] }, { "name": "Get daily summaries · today", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Single-day queries return a summary object or an empty array; month/range queries return an array.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/summaries/today", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "summaries", "today" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: drivemark, violation_details, costing." } ] } }, "response": [] }, { "name": "Get daily summaries · yesterday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Single-day queries return a summary object or an empty array; month/range queries return an array.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/summaries/yesterday", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "summaries", "yesterday" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: drivemark, violation_details, costing." } ] } }, "response": [] }, { "name": "Get daily summaries · range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. The supplied start is rounded to start of its day; the supplied end is rounded to start of its day plus one day. Single-day queries return a summary object or an empty array; month/range queries return an array.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/summaries/duration", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "summaries", "duration" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": false, "description": "Range start parsed in timezone (device timezone by default)." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": false, "description": "Range end parsed in timezone (device timezone by default)." }, { "key": "timezone", "value": "Asia/Kuala_Lumpur", "disabled": true, "description": "IANA timezone overriding the device timezone for range parsing." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: drivemark, violation_details, costing." } ] } }, "response": [] }, { "name": "Get daily summaries · date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Single-day queries return a summary object or an empty array; month/range queries return an array.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/summaries/:year/:month/:day", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "summaries", ":year", ":month", ":day" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" }, { "key": "day", "value": "15" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: drivemark, violation_details, costing." } ] } }, "response": [] }, { "name": "Get daily summaries · month", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Single-day queries return a summary object or an empty array; month/range queries return an array.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/summaries/:year/:month", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "summaries", ":year", ":month" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: drivemark, violation_details, costing." } ] } }, "response": [] } ] }, { "name": "Track statistics", "item": [ { "name": "Get track statistics · default", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Alias for today. Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/tracks", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "tracks" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Get track statistics · today", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/tracks/today", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "tracks", "today" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Get track statistics · yesterday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/tracks/yesterday", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "tracks", "yesterday" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Get track statistics · range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Rejects ranges whose diffInHours exceeds 24 with 416.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/tracks/duration", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "tracks", "duration" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": false, "description": "Range start parsed in timezone (device timezone by default)." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": false, "description": "Range end parsed in timezone (device timezone by default)." }, { "key": "timezone", "value": "Asia/Kuala_Lumpur", "disabled": true, "description": "IANA timezone overriding the device timezone for range parsing." } ] } }, "response": [] }, { "name": "Get track statistics · date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/tracks/:year/:month/:day", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "tracks", ":year", ":month", ":day" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" }, { "key": "day", "value": "15" } ] } }, "response": [] } ] }, { "name": "Travels", "item": [ { "name": "Get travels · default", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Alias for today. Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: type, drivemark." }, { "key": "excludes", "value": "example", "disabled": true, "description": "Comma-separated removable fields: histories." } ] } }, "response": [] }, { "name": "Get travels · today", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/today", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "today" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: type, drivemark." }, { "key": "excludes", "value": "example", "disabled": true, "description": "Comma-separated removable fields: histories." } ] } }, "response": [] }, { "name": "Get travels · yesterday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/yesterday", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "yesterday" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: type, drivemark." }, { "key": "excludes", "value": "example", "disabled": true, "description": "Comma-separated removable fields: histories." } ] } }, "response": [] }, { "name": "Get travels · range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone. Rejects ranges whose diffInHours exceeds 48 with 416.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/duration", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "duration" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": false, "description": "Range start parsed in timezone (device timezone by default)." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": false, "description": "Range end parsed in timezone (device timezone by default)." }, { "key": "timezone", "value": "Asia/Kuala_Lumpur", "disabled": true, "description": "IANA timezone overriding the device timezone for range parsing." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: type, drivemark." }, { "key": "excludes", "value": "example", "disabled": true, "description": "Comma-separated removable fields: histories." } ] } }, "response": [] }, { "name": "Get travels · date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/:year/:month/:day", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", ":year", ":month", ":day" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" }, { "key": "day", "value": "15" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: type, drivemark." }, { "key": "excludes", "value": "example", "disabled": true, "description": "Comma-separated removable fields: histories." } ] } }, "response": [] }, { "name": "Get one travel", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Returns one trip with drivemark requested by the controller.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/:id", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", ":id" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "id", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: type, drivemark." }, { "key": "excludes", "value": "example", "disabled": true, "description": "Comma-separated removable fields: histories." } ] } }, "response": [] } ] }, { "name": "Travel summaries", "item": [ { "name": "Get travel summaries · default", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Alias for today. Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: start, end, drivemark, type, driver, odometer." } ] } }, "response": [] }, { "name": "Get travel summaries · today", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/today", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", "today" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: start, end, drivemark, type, driver, odometer." } ] } }, "response": [] }, { "name": "Get travel summaries · yesterday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/yesterday", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", "yesterday" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: start, end, drivemark, type, driver, odometer." } ] } }, "response": [] }, { "name": "Get travel summaries · range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/duration", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", "duration" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": false, "description": "Range start parsed in timezone (device timezone by default)." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": false, "description": "Range end parsed in timezone (device timezone by default)." }, { "key": "timezone", "value": "Asia/Kuala_Lumpur", "disabled": true, "description": "IANA timezone overriding the device timezone for range parsing." }, { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: start, end, drivemark, type, driver, odometer." } ] } }, "response": [] }, { "name": "Get travel summaries · date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/:year/:month/:day", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", ":year", ":month", ":day" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" }, { "key": "day", "value": "15" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: start, end, drivemark, type, driver, odometer." } ] } }, "response": [] }, { "name": "Get travel summaries · month", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Calendar boundaries use the vehicle timezone.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/:year/:month", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", ":year", ":month" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "year", "value": "2026" }, { "key": "month", "value": "01" } ], "query": [ { "key": "includes", "value": "example", "disabled": true, "description": "Comma-separated optional fields: start, end, drivemark, type, driver, odometer." } ] } }, "response": [] }, { "name": "Get a single travel summary — known failure", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "This endpoint currently returns a server error after vehicle authorization: the action calls trips() on the route string rather than the resolved device. Use the travel-summary list endpoints to retrieve summaries. Authentication, vehicle access, vehicle-not-found and throttling errors can occur before this failure.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/:id", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", ":id" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "id", "value": "1001" } ] } }, "response": [] }, { "name": "Update a travel type", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Updates the travel type.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/travels/summaries/:id", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "travels", "summaries", ":id" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "id", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"business\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Sharing", "item": [ { "name": "List your active vehicle shares", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Only active shares belonging to the authenticated user for this vehicle are returned. Share tokens and URLs are credentials.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/sharing", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "sharing" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Create a vehicle share", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Creates a private, time-limited vehicle share. Treat the returned share token and URL as credentials.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/sharing", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "sharing" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Example integration\",\n \"duration\": \"1D\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a vehicle share", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Deletes the vehicle share and ends access through that share.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/sharing/:share", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "sharing", ":share" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "share", "value": "1001" } ] } }, "response": [] }, { "name": "Update a vehicle share", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Changing duration recalculates expiry from the current time. Omitting description preserves its current value. This operation changes data.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/sharing/:share", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "sharing", ":share" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "share", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Example integration\",\n \"duration\": \"1D\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Driver logs", "item": [ { "name": "List fuel records", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Reads start/end as device-timezone timestamps. The controller separately validates from_date/to_date but does not use those fields for filtering; use start/end.", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuels", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuels" ], "variable": [ { "key": "vehicle", "value": "1001" } ], "query": [ { "key": "start", "value": "2026-01-15 00:00:00", "disabled": true, "description": "Optional start timestamp in the vehicle timezone." }, { "key": "end", "value": "2026-01-15 23:59:59", "disabled": true, "description": "Optional end timestamp in the vehicle timezone." } ] } }, "response": [] }, { "name": "Create a fuel record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "May update an existing record when platform_id is supplied or a record has the same tracked_at. Send litre for refuel volume; the output is refuel_manual. This operation changes data.", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuels", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuels" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "odometer", "type": "text", "value": "12000", "disabled": false }, { "key": "litre", "type": "text", "value": "20", "disabled": false }, { "key": "total_cost", "type": "text", "value": "1", "disabled": true }, { "key": "price_litre", "type": "text", "value": "2.5", "disabled": false }, { "key": "fuel_type", "type": "text", "value": "Diesel", "disabled": false }, { "key": "latitude", "type": "text", "value": "0", "disabled": false }, { "key": "longitude", "type": "text", "value": "0", "disabled": false }, { "key": "tracked_at", "type": "text", "value": "2026-01-15 08:30:00", "disabled": false }, { "key": "timezone", "type": "text", "value": "UTC", "disabled": false }, { "key": "notes", "type": "text", "value": "example", "disabled": true }, { "key": "user_id", "type": "text", "value": "1", "disabled": true }, { "key": "platform_id", "type": "text", "value": "1", "disabled": true }, { "key": "receipt", "type": "file", "src": [], "description": "Choose your own local image before sending.", "disabled": true } ] } }, "response": [] }, { "name": "Get a fuel record", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuels/:fuel", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuels", ":fuel" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "fuel", "value": "1001" } ] } }, "response": [] }, { "name": "Update a fuel record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "The API intentionally uses POST for this update. This operation changes data.", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuels/:fuel", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuels", ":fuel" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "fuel", "value": "1001" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "odometer", "type": "text", "value": "12000", "disabled": false }, { "key": "litre", "type": "text", "value": "20", "disabled": false }, { "key": "total_cost", "type": "text", "value": "1", "disabled": true }, { "key": "price_litre", "type": "text", "value": "2.5", "disabled": false }, { "key": "fuel_type", "type": "text", "value": "Diesel", "disabled": false }, { "key": "latitude", "type": "text", "value": "0", "disabled": false }, { "key": "longitude", "type": "text", "value": "0", "disabled": false }, { "key": "tracked_at", "type": "text", "value": "2026-01-15 08:30:00", "disabled": false }, { "key": "timezone", "type": "text", "value": "UTC", "disabled": false }, { "key": "notes", "type": "text", "value": "example", "disabled": true }, { "key": "user_id", "type": "text", "value": "1", "disabled": true }, { "key": "platform_id", "type": "text", "value": "1", "disabled": true }, { "key": "receipt", "type": "file", "src": [], "description": "Choose your own local image before sending.", "disabled": true } ] } }, "response": [] }, { "name": "Delete a fuel record", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Deletes a vehicle fuel record.", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuels/:fuel", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuels", ":fuel" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "fuel", "value": "1001" } ] } }, "response": [] }, { "name": "List driver reports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/reports", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "reports" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Create a driver report", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "pictures are uploaded files. Priority accepts any integer; no range is enforced. This operation changes data.", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/reports", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "reports" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "message", "type": "text", "value": "Example vehicle inspection note", "disabled": false }, { "key": "priority", "type": "text", "value": "1", "disabled": false }, { "key": "latitude", "type": "text", "value": "1", "disabled": true }, { "key": "longitude", "type": "text", "value": "1", "disabled": true }, { "key": "pictures[]", "type": "file", "src": [], "description": "Choose your own local image before sending.", "disabled": true } ] } }, "response": [] }, { "name": "Get a driver report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/reports/:report", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "reports", ":report" ], "variable": [ { "key": "vehicle", "value": "1001" }, { "key": "report", "value": "1001" } ] } }, "response": [] }, { "name": "Get configured fuel types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuel_types", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuel_types" ], "variable": [ { "key": "vehicle", "value": "1001" } ] } }, "response": [] }, { "name": "Update configured fuel types", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Updates the vehicle fuel types.", "url": { "raw": "{{base_url}}/drivers/vehicles/:vehicle/fuel_types", "host": [ "{{base_url}}" ], "path": [ "drivers", "vehicles", ":vehicle", "fuel_types" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"fuel_types\": [\n \"Diesel\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Assistance", "item": [ { "name": "Request breakdown assistance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Creates a one-day private vehicle share and queues an SMS to the authenticated account's configured emergency mobile contact, including the share link. Requires vehicle view permission. A successful response confirms the controller queued the notification, not that an SMS was delivered. This operation has real-world side effects; use only with an approved account and recipient. The controller reads description without explicit field validation.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/assist/breakdown", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "assist", "breakdown" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Example assistance request\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Request emergency assistance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Creates a one-day private vehicle share and queues an SMS to the authenticated account's configured emergency mobile contact, including the share link. Requires vehicle view permission. A successful response confirms the controller queued the notification, not that an SMS was delivered. This operation has real-world side effects; use only with an approved account and recipient. The controller reads description without explicit field validation.", "url": { "raw": "{{base_url}}/vehicles/:vehicle/assist/emergency", "host": [ "{{base_url}}" ], "path": [ "vehicles", ":vehicle", "assist", "emergency" ], "variable": [ { "key": "vehicle", "value": "1001" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Example assistance request\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Video operations", "item": [ { "name": "List MDVR live streams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires an accessible vehicle with supported MDVR configuration and provider access. This GET can authenticate with external video providers, query provider status and update caches while assembling access-bearing links. Account features and provider behavior depend on the MDVR configuration. Keep returned video links private and out of logs.", "url": { "raw": "{{base_url}}/operations/stream", "host": [ "{{base_url}}" ], "path": [ "operations", "stream" ], "variable": [], "query": [ { "key": "stream", "value": "1", "disabled": true, "description": "Howen stream selector read by the action; default depends on channel count. No request validation is declared." }, { "key": "panel", "value": "0", "disabled": true, "description": "Howen panel selector; defaults to 0. No request validation is declared." } ] } }, "response": [] }, { "name": "Get an MDVR live stream", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires an accessible vehicle with supported MDVR configuration and provider access. This GET can authenticate with external video providers, query provider status and update caches while assembling access-bearing links. Keep returned video links private and out of logs. Send vehicleID and channel explicitly: the action does not validate their presence or types, and omitting channel can leave a placeholder in the returned link.", "url": { "raw": "{{base_url}}/operations/stream/show", "host": [ "{{base_url}}" ], "path": [ "operations", "stream", "show" ], "variable": [], "query": [ { "key": "vehicleID", "value": "1001", "disabled": true, "description": "Accessible MDVR vehicle identifier. Omission is not validated and can fail to select a vehicle." }, { "key": "channel", "value": "1", "disabled": true, "description": "Provider channel selector from the stream index. If omitted, a placeholder may remain." }, { "key": "stream", "value": "1", "disabled": true, "description": "Howen stream selector; provider-specific." }, { "key": "panel", "value": "0", "disabled": true, "description": "Howen panel selector; provider-specific." } ] } }, "response": [] }, { "name": "List MDVR playback records", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Lists stored playback records for vehicles available to the account with supported MDVR configuration. This GET can contact external MDVR providers for status and update caches; provider authentication and feature access are required. It does not itself request a new recording. Returned provider or playback access details are private.", "url": { "raw": "{{base_url}}/operations/playback", "host": [ "{{base_url}}" ], "path": [ "operations", "playback" ], "variable": [] } }, "response": [] }, { "name": "Download a stored playback video", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires view permission on the playback vehicle. Streams an existing file from configured MDVR storage as an MP4 attachment. This GET reads storage and can invoke external storage access. Missing playback records can cause a server error rather than a 404. File availability depends on the configured storage.", "url": { "raw": "{{base_url}}/operations/playback/:id/download", "host": [ "{{base_url}}" ], "path": [ "operations", "playback", ":id", "download" ], "variable": [ { "key": "id", "value": "1001" } ] } }, "response": [] }, { "name": "Get stored playback preview metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Requires view permission on the playback vehicle. Missing playback records can cause a server error rather than a 404. The url field is assigned the PreviewVideo action object rather than a generated temporary URL. Its serialized value is not specified; do not assume it is a usable preview link. Keep any access-bearing link private. This GET can resolve storage and device state; external/provider behavior is not fully specified.", "url": { "raw": "{{base_url}}/operations/playback/:id/preview", "host": [ "{{base_url}}" ], "path": [ "operations", "playback", ":id", "preview" ], "variable": [ { "key": "id", "value": "1001" } ] } }, "response": [] } ] }, { "name": "Subscriptions", "item": [ { "name": "List vehicle subscription status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Returns the account's devices with their subscription status. The subscription field is currently null because detailed renewal data is disabled. Keep device identifiers private. Check returned values when handling expiry and provider data; exact value types and expiry behavior are not fully specified.", "url": { "raw": "{{base_url}}/subscriptions", "host": [ "{{base_url}}" ], "path": [ "subscriptions" ], "variable": [] } }, "response": [] }, { "name": "Create a subscription renewal bill", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Creates a pending renewal transaction, updates subscription start/duration/end metadata and transaction links, then creates an external Billplz bill using the account's contact details. This starts a payment flow and does not itself confirm payment. Each selected subscription must belong to the account. subscription defaults to an empty array and period to 1; the action applies no explicit field validator. Check both fields before sending. The response is the raw Transaction model, not a pay_url wrapper.", "url": { "raw": "{{base_url}}/subscriptions/pay", "host": [ "{{base_url}}" ], "path": [ "subscriptions", "pay" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"subscription\": [\n 1001\n ],\n \"period\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Request subscription renewal support", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.KATSANA.v1+json" }, { "key": "Time-Zone", "value": "Asia/Kuala_Lumpur" } ], "description": "Queues a renewal-support email using the account's identity and contact details. Pass device as a list of device IDs; the job loads those devices and classifies terminated or unsubscribed vehicles. A successful response confirms dispatch, not email delivery. The action applies no explicit field validator or per-device ownership check; send only devices the account is authorized to manage.", "url": { "raw": "{{base_url}}/subscriptions/notify", "host": [ "{{base_url}}" ], "path": [ "subscriptions", "notify" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"device\": [\n 1001\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ] }