> ## Documentation Index > Fetch the complete documentation index at: https://support.keypro.fi/llms.txt > Use this file to discover all available pages before exploring further. # Get list of Task > Operation is used to get a list of task. Task list can be filtered by giving filtering parameters at HTTP querystring (see parameters). ## OpenAPI ````json GET /tasks/ { "info": { "contact": { "email": "keypro@keypro.fi", "name": "Keypro Oy", "url": "https://keypro.fi/" }, "license": { "name": "Copyright (C) Keypro Oy. All rights reserved.", "url": "https://www.keypro.fi/" }, "termsOfService": "https://www.keypro.fi/en/terms-of-service", "title": "Keyduct REST API", "version": "2.0.0" }, "tags": [ { "description": "Task related operations.", "name": "Task" }, { "description": "Subregion related operations.", "name": "Subregion" }, { "description": "SAttribute related operations.", "name": "SAttribute" }, { "description": "Fault related operations.", "name": "Fault" }, { "description": "Maintenance history related operations.", "name": "Maintenance history" }, { "description": "Deflection related operations.", "name": "Deflection" }, { "description": "Fault Component related operations.", "name": "Fault Component" }, { "description": "Task comment related operations.", "name": "Task Comment" }, { "description": "FaultComponentFault related operations.", "name": "FaultComponentFault" }, { "description": "Collection related operations.", "name": "Collections" }, { "description": "ContactPerson related operations", "name": "Contact Person" }, { "description": "ContactPersonConnection related operations", "name": "Contact Person Connection" }, { "description": "Plan related operations.", "name": "Plan" }, { "description": "FreeArea related operations.", "name": "FreeArea" }, { "description": "Building address related operations.", "name": "Address" }, { "description": "Building apartments related operations.", "name": "Apartment" }, { "description": "Customer data related operations.", "name": "Customer" }, { "description": "Customer contract related operations.", "name": "Customer Contract" }, { "description": "Extra attributes related operations.", "name": "Extra Attribute" }, { "description": "Extra attribute values related operations.", "name": "Extra Value" }, { "description": "Consumer point related operations.", "name": "Consumer Point" }, { "description": "Consumer point address link related operations.", "name": "Consumer Point Linked Address" }, { "description": "Flow Meter related operations.", "name": "Flow Meter" }, { "description": "Text Constant related operations.", "name": "Text Constant" }, { "description": "Sn Constant related operations.", "name": "Sn Constant" }, { "description": "Gas Meter related operations.", "name": "Gas Meter" }, { "description": "Junction related operations.", "name": "Junction" }, { "description": "Junction Connection related operations.", "name": "Junction Connection" }, { "description": "External documents related operations.", "name": "External Document" }, { "description": "Water duct renovation related operations.", "name": "Water Duct Renovation" }, { "description": "Sewer duct renovation related operations.", "name": "Sewer Duct Renovation" }, { "description": "Water duct related operations.", "name": "Water Duct" }, { "description": "Water other node related operations.", "name": "Water Other Node" }, { "description": "Water hydrant related operations.", "name": "Water Hydrant" }, { "description": "Water branch related operations.", "name": "Water Branch" }, { "description": "Water measuring point related operations.", "name": "Water Measuring Point" }, { "description": "Fire water station related operations.", "name": "Fire Water Station" }, { "description": "Water fireplug related operations.", "name": "Water Fireplug" }, { "description": "Sewer duct related operations.", "name": "Sewer Duct" }, { "description": "Flow Meter Reading related operations.", "name": "Flow Meter Reading" }, { "description": "Gas meter reading related operations.", "name": "Gas Meter Reading" }, { "description": "Gas cable related operations.", "name": "Gas Cable" }, { "description": "Gas other node related operations.", "name": "Gas Other Node" }, { "description": "Gas valve related operations.", "name": "Gas Valve" }, { "description": "Water node related operations.", "name": "Water Node" }, { "description": "Consumer point property related operations.", "name": "Consumer Point Property" }, { "description": "Dh manhole related operations.", "name": "Dh Manhole" }, { "description": "Dh Manhole Link Connection related operations.", "name": "Dh Manhole Link Connection" }, { "description": "Dh cable related operations.", "name": "Dh Cable" }, { "description": "Error report related operations.", "name": "Error Report" }, { "description": "Failure report related operations.", "name": "Failure Report" }, { "description": "Dh duct related operations.", "name": "Dh Duct" }, { "description": "Dh conduit related operations.", "name": "Dh Conduit" }, { "description": "Dh division related operations.", "name": "Dh Division" }, { "description": "Dh valve related operations.", "name": "Dh Valve" }, { "description": "Consumer Point User related operations.", "name": "Consumer Point User" }, { "description": "Consumer point real estate related operations.", "name": "Consumer Point Real Estate" }, { "description": "Consumer point user email related operations.", "name": "Consumer Point User Email" }, { "description": "Water pumping station related operations.", "name": "Water Pumping Station" }, { "description": "Dh Meter Reading related operations.", "name": "Dh Meter Reading" }, { "description": "Consumer point connection related operations.", "name": "Consumer Point Connection" }, { "description": "Modeling data related operations.\n\n*NOTE:* Contrary to what is described in chapter 1.5, the base path for all of these operations is `/keyaqua_modeling`\n", "name": "Modeling Data" }, { "description": "Gas manhole related operations.", "name": "Gas Manhole" }, { "description": "KeyDh Observation related operations.", "name": "KeyDh Observation" }, { "description": "KeyDh Supply Interruption related operations.", "name": "KeyDh Supply Interruption" }, { "description": "KeyDh Supply Interruption Connection related operations.", "name": "KeyDh Supply Interruption Connection" }, { "description": "Keydh Node related operations.", "name": "Keydh Node" }, { "description": "Keygas Duct related operations.", "name": "Keygas Duct" }, { "description": "Real Estate related operations.", "name": "Real Estate" }, { "description": "Keydh Connection related operations.", "name": "Keydh Connection" }, { "description": "Water Tank related operations.", "name": "Water Tank" }, { "description": "Water Valve related operations.", "name": "Water Valve" }, { "description": "Point related operations.", "name": "Point" }, { "description": "Sn Modeling related operations.", "name": "Sn Modeling" }, { "description": "Sewer Manholes v2 related operations.", "name": "Sewer Manholes v2" }, { "description": "Sewer Ducts related operations.", "name": "Sewer Ducts" }, { "description": "Sewer Valves related operations.", "name": "Sewer Valves" }, { "description": "Sewer Pumping Stations related operations.", "name": "Sewer Pumping Stations" }, { "description": "Sewer Branches related operations.", "name": "Sewer Branches" }, { "description": "Sewer Measuring Poins related operations.", "name": "Sewer Measuring Poins" }, { "description": "Sewer Other Nodes related operations.", "name": "Sewer Other Nodes" }, { "description": "Keydh Conduit Link related operations.", "name": "Keydh Conduit Link" }, { "description": "Duct condition detail related operations.", "name": "Duct Condition Detail" }, { "description": "KeyDh Conduit Error related operations.", "name": "KeyDh Conduit Error" }, { "description": "AquaObjectType related operations.", "name": "AquaObjectType" }, { "description": "AquaMeasuringPointTypes related operations.", "name": "AquaMeasuringPointTypes" }, { "description": "AquaPumpType related operations.", "name": "AquaPumpType" }, { "description": "AquaBranchType related operations.", "name": "AquaBranchType" }, { "description": "AquaValveType related operations.", "name": "AquaValveType" }, { "description": "AquaManholeType related operations.", "name": "AquaManholeType" }, { "description": "AquaDuctType related operations.", "name": "AquaDuctType" }, { "description": "SnDuctType related operations.", "name": "SnDuctType" }, { "description": "SnManholeType related operations.", "name": "SnManholeType" }, { "description": "SnLidType related operations.", "name": "SnLidType" }, { "description": "Sewer Node related operations.", "name": "Sewer Nodes" }, { "description": "Sn Control related operations.", "name": "Sn Control" }, { "description": "KeyDh Shell Type related operations.", "name": "KeyDh Shell Type" }, { "description": "Sewer Branch Type related operations.", "name": "Sewer Branch Type" }, { "description": "Sewer Valve Type related operations.", "name": "Sewer Valve Type" } ], "paths": { "/tasks/": { "get": { "description": "Operation is used to get a list of task.\n\nTask list can be filtered by giving filtering parameters at HTTP querystring (see parameters).\n", "operationId": "getKeyworkTasks", "parameters": [ { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/srsParam" }, { "$ref": "#/parameters/filterParam" }, { "$ref": "#/parameters/orderParam" } ], "responses": { "200": { "description": "A result response object.", "examples": { "application/json": { "Next": "http://example.keypro.fi/api/v2/tasks/?endDate__isnull=0&limit=3&offset=3", "Previous": null, "Results": [ { "automaticRepeat": "1", "closedInfo": "{}", "currentStateInfo": { "createdBy": "example@keypro.fi", "createdTs": "2024-11-05T13:25:59.644613", "state": { "description": "Open", "groupname": "STATUS", "id": "235", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/", "name": "STATUS_OPEN_OPEN", "numValue": null, "orderno": "0", "txtValue": null } }, "endDate": "2025-01-11", "executionCycle": "15", "id": "21", "inProgressInfo": "{}", "name": "test task update", "network": { "description": "Telecommunication", "groupname": "TASK_NETWORK", "id": "275", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TASK_NETWORK/", "name": "TELECOMMUNICATION", "numValue": null, "orderno": "1", "txtValue": null }, "openInfo": { "createdBy": "example@keypro.fi", "createdTs": "2024-11-05T13:25:59.644613", "state": { "description": "Open", "groupname": "STATUS", "id": "235", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/", "name": "STATUS_OPEN_OPEN", "numValue": null, "orderno": "0", "txtValue": null } }, "orderInfo": "{}", "plan": "false", "repeatOrderNum": null, "repeatParent": null, "repeatable": "1", "startDate": "2025-01-05", "subregion": null, "taskCategory": { "description": "Lamp / fixture", "groupname": "TYPE", "id": "240", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/", "name": "TYPE_1_LAMP", "numValue": null, "orderno": "0", "txtValue": null }, "taskIdentifier": "sfds", "taskLocation": "SRID=3067;POINT Z (457081.23677634 6702634.548369 0)" }, { "automaticRepeat": "1", "closedInfo": "{}", "currentStateInfo": { "createdBy": "example@keypro.fi", "createdTs": "2025-01-22T12:54:23.163785", "state": { "description": "Open", "groupname": "STATUS", "id": "235", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/", "name": "STATUS_OPEN_OPEN", "numValue": null, "orderno": "0", "txtValue": null } }, "endDate": "2025-01-17", "executionCycle": "15", "id": "777", "inProgressInfo": "{}", "name": "test task update", "network": { "description": "Telecommunication", "groupname": "TASK_NETWORK", "id": "275", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TASK_NETWORK/", "name": "TELECOMMUNICATION", "numValue": null, "orderno": "1", "txtValue": null }, "openInfo": { "createdBy": "example@keypro.fi", "createdTs": "2025-01-22T12:54:23.163785", "state": { "description": "Open", "groupname": "STATUS", "id": "235", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/", "name": "STATUS_OPEN_OPEN", "numValue": null, "orderno": "0", "txtValue": null } }, "orderInfo": "{}", "plan": "false", "repeatOrderNum": "1", "repeatParent": "http://example.keypro.fi/api/v2/tasks/21/", "repeatable": "1", "startDate": "2025-04-19", "subregion": null, "taskCategory": { "description": "Lamp / fixture", "groupname": "TYPE", "id": "240", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/", "name": "TYPE_1_LAMP", "numValue": null, "orderno": "0", "txtValue": null }, "taskIdentifier": "sfds/1", "taskLocation": "SRID=3067;POINT Z (457081.23677634 6702634.548369 0)" }, { "automaticRepeat": "0", "closedInfo": "{}", "currentStateInfo": { "createdBy": "example@keypro.fi", "createdTs": "2025-04-04T13:36:20.184046", "state": { "description": "Open", "groupname": "STATUS", "id": "235", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/", "name": "STATUS_OPEN_OPEN", "numValue": null, "orderno": "0", "txtValue": null } }, "endDate": "2025-04-18", "executionCycle": "4", "id": "985", "inProgressInfo": "{}", "name": "25-9", "network": { "description": "Lightning", "groupname": "TASK_NETWORK", "id": "276", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TASK_NETWORK/", "name": "LIGHTNING", "numValue": null, "orderno": "2", "txtValue": null }, "openInfo": { "createdBy": "example@keypro.fi", "createdTs": "2025-04-04T13:36:20.184046", "state": { "description": "Open", "groupname": "STATUS", "id": "235", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/STATUS/", "name": "STATUS_OPEN_OPEN", "numValue": null, "orderno": "0", "txtValue": null } }, "orderInfo": "{}", "plan": "false", "repeatOrderNum": null, "repeatParent": null, "repeatable": "1", "startDate": "2025-04-04", "subregion": null, "taskCategory": { "description": "Other", "groupname": "TYPE", "id": "244", "list_url": "http://example.keypro.fi/api/v2/sattrs/groupname/TYPE/", "name": "TYPE_3_ANOTHER_TASK", "numValue": null, "orderno": "5", "txtValue": null }, "taskIdentifier": "25-9", "taskLocation": "SRID=3067;POINT Z (385718.85021608 6682056.7892952 0)" } ], "Total": "8" } }, "schema": { "properties": { "Next": { "description": "Url to next page of Keywork tasks list. Null if No next page exist", "format": "url", "type": "string" }, "Previous": { "description": "Url to previous page of Keywork tasks list. Null if No previous page exist", "format": "url", "type": "string" }, "Results": { "description": "List of fetched Tasks", "items": { "$ref": "#/definitions/KeyworkTask" }, "type": "array" }, "Total": { "description": "Total number of Keywork tasks", "type": "integer" } }, "type": "object" } }, "401": { "$ref": "#/responses/Http401" } }, "security": [ { "Token": [] } ], "summary": "Get list of Task", "tags": [ "Task" ] } } } } ````