> ## 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  poles

> Operation is used to get a list of poles. Available from product version 3.2.24.

Poles can be filtered by giving filtering parameters at HTTP querystring (see parameters).


## OpenAPI

````json GET /poles/
{
  "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": "KeyCom REST API",
    "version": "2.0.0"
  },
  "tags": [
    {
      "description": "Plan related operations.",
      "name": "Plan"
    },
    {
      "description": "FreeArea related operations.",
      "name": "FreeArea"
    },
    {
      "description": "FreeLine related operations.",
      "name": "FreeLine"
    },
    {
      "description": "FreeText related operations.",
      "name": "FreeText"
    },
    {
      "description": "FreeText component related operations.",
      "name": "FreeTextComponent"
    },
    {
      "description": "Building address related operations.",
      "name": "Address"
    },
    {
      "description": "Building apartments related operations.",
      "name": "Apartment"
    },
    {
      "description": "Extra attributes related operations.",
      "name": "Extra Attribute"
    },
    {
      "description": "Extra attribute values related operations.",
      "name": "Extra Value"
    },
    {
      "description": "External documents related operations.",
      "name": "External Document"
    },
    {
      "description": "Attached Documents related operations.",
      "name": "Attached Document"
    },
    {
      "description": "Collection related operations.",
      "name": "Collections"
    },
    {
      "description": "External source system derived apartment related operations.",
      "name": "Source system apartment"
    },
    {
      "description": "External source system derived address related operations.",
      "name": "Source system address"
    },
    {
      "description": "Address aliases related operations",
      "name": "Address alias"
    },
    {
      "description": "TxtConstants related operations.",
      "name": "TxtConstant"
    },
    {
      "description": "Point objects related operations.",
      "name": "Point"
    },
    {
      "description": "Survey Constants related operations.",
      "name": "Survey Constant"
    },
    {
      "description": "Survey Points related operations.",
      "name": "Survey Point"
    },
    {
      "description": "Survey Line Strings related operations.",
      "name": "Survey Line String"
    },
    {
      "description": "Template Catalog related operations.",
      "name": "Template Catalog"
    },
    {
      "description": "Route following related operations.",
      "name": "Route Following"
    },
    {
      "description": "Contact person related operations.",
      "name": "Contact Person"
    },
    {
      "description": "Contact person connection related operations.",
      "name": "Contact Person Connection"
    },
    {
      "description": "Telecom premises related operations.",
      "name": "Telecom premises"
    },
    {
      "description": "Device related operations.",
      "name": "Device"
    },
    {
      "description": "Device Group related operations.",
      "name": "Device Group"
    },
    {
      "description": "Telecom Splice related operations.",
      "name": "Splice"
    },
    {
      "description": "Telecom Conduit related operations.",
      "name": "Telecom Conduit"
    },
    {
      "description": "Operations related to putting Telecom Cables and Ducts into Conduits.",
      "name": "Telecom Conduit Link"
    },
    {
      "description": "Telecom Duct related operations.",
      "name": "Telecom Duct"
    },
    {
      "description": "Operations related to putting Telecom Cables into Ducts.",
      "name": "Telecom Duct Link"
    },
    {
      "description": "Operations related to connecting Conduits and endpoints.",
      "name": "Telecom Conduit Connection"
    },
    {
      "description": "Operations related to connecting Cables and endpoints",
      "name": "Telecom Cable Connection"
    },
    {
      "description": "Operations related to connecting and disconnecting telecom cable threads and device ports",
      "name": "Telecom Thread/Port Connection"
    },
    {
      "description": "Operations related to connecting Telecom Ducts to Telecom Premises or Manhole.",
      "name": "Telecom Duct Connection"
    },
    {
      "description": "Telecom Manhole related operations.",
      "name": "Manhole"
    },
    {
      "description": "Telecom Cable related operations.",
      "name": "Cable"
    },
    {
      "description": "Cable Appendix operations for connecting Cables to loops. Manages the relationship between Cables and loops, automatically adjusting Cable extra_length when appendixes are created, updated, or deleted.",
      "name": "Cable Appendix"
    },
    {
      "description": "Telecom Supercable related operations.",
      "name": "Supercable"
    },
    {
      "description": "Cross connection point related operations.",
      "name": "Cross connection point"
    },
    {
      "description": "Service Area related operations.",
      "name": "Service Area"
    },
    {
      "description": "Exchange Area related operations.",
      "name": "Exchange Area"
    },
    {
      "description": "Telecom Area related operations.",
      "name": "Telecom Area"
    },
    {
      "description": "Routefollower related operations.",
      "name": "Routefollower"
    },
    {
      "description": "Circuit related operations.",
      "name": "Circuit"
    },
    {
      "description": "Circuit installation location related operations.",
      "name": "Circuit Location"
    },
    {
      "description": "Circuit section related operations.",
      "name": "Circuit Section"
    },
    {
      "description": "Circuit reservation data view and search operations.",
      "name": "Circuit Reservation Data"
    },
    {
      "description": "Customer data related operations.",
      "name": "Customer"
    },
    {
      "description": "Passed Services related operations.",
      "name": "Passed Services"
    },
    {
      "description": "Circuit logical reservations related operations.",
      "name": "Circuit Connection"
    },
    {
      "description": "Circuit physical reservations related operations.",
      "name": "Circuit Physical Reservation"
    },
    {
      "description": "Operation used to create new connections.",
      "name": "Create connections"
    },
    {
      "description": "Terminal types related operations.",
      "name": "Terminal type"
    },
    {
      "description": "Logical connections related operations.",
      "name": "Logical connections"
    },
    {
      "description": "Operations provided by micro services.",
      "name": "Circuit Services"
    },
    {
      "description": "Contract related operations.",
      "name": "Contract"
    },
    {
      "description": "Contract link related operations.",
      "name": "Contract Link"
    },
    {
      "description": "Pole related operations.",
      "name": "Pole"
    },
    {
      "description": "Circuit faults related operations.",
      "name": "Circuit faults"
    },
    {
      "description": "Duct groups related operations.",
      "name": "Duct groups"
    },
    {
      "description": "Duct group rows related operations.",
      "name": "Duct group rows"
    },
    {
      "description": "Cable thread related operations.",
      "name": "Threads"
    },
    {
      "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"
    }
  ],
  "paths": {
    "/poles/": {
      "get": {
        "description": "Operation is used to get a list of poles. Available from product version 3.2.24.\n\nPoles can be filtered by giving filtering parameters at HTTP querystring (see parameters).\n",
        "operationId": "getPoles",
        "parameters": [
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/srsParam"
          },
          {
            "$ref": "#/parameters/precisionParam"
          },
          {
            "$ref": "#/parameters/dimsParam"
          },
          {
            "$ref": "#/parameters/filterParam"
          },
          {
            "$ref": "#/parameters/orderParam"
          }
        ],
        "responses": {
          "200": {
            "description": "A result response object.",
            "examples": {
              "application/json": {
                "Next": "http://example.keypro.fi/api/v2/pole/?limit=10&offset=10",
                "Previous": null,
                "Results": [
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "10",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (457671.1584000000148080 6702815.5481000002473593 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "4921",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": "1.0",
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "sergei",
                    "updated_ts": "2012-03-26T11:39:54",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "30",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (457635.0541000000084750 6702789.5608999999240041 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "4921",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:49",
                    "usage_state": "770"
                  },
                  {
                    "angle": "88.16226162490963",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "410",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (457563.0280999999959022 6703141.6618999997153878 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:49",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "810",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458260.5511999999871477 6696463.3857000004500151 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "830",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458304.2228999999933876 6696397.4469999996945262 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "850",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458330.0581000000238419 6696374.8507000003010035 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "870",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458358.6934999999939464 6696350.1117000002413988 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "890",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458178.6506999999983236 6696509.4546999996528029 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "910",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458273.2860000000218861 6696463.2153000002726912 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  },
                  {
                    "angle": "90.0",
                    "branch_pole_number": "",
                    "checkout_date": null,
                    "created_by": "",
                    "created_ts": null,
                    "decay_class": null,
                    "height_accuracy": "117210",
                    "history_date": null,
                    "id": "930",
                    "impregnant": null,
                    "install_year": null,
                    "length": "0.0",
                    "line_part": "",
                    "location": "SRID=3067;POINT Z (458280.1165000000037253 6696418.9720000000670552 0.0000000000000000)",
                    "location_accuracy": "8301",
                    "mapper": "",
                    "mapping_method": null,
                    "material": "7341",
                    "owner": "2850",
                    "plan": null,
                    "pole_number": "",
                    "pole_type": "1601",
                    "remarks": "",
                    "renter": null,
                    "scale": null,
                    "stanchion": null,
                    "station_decay_class": null,
                    "survey_amount": "",
                    "telecom_area": null,
                    "updated_by": "KEYCOM_STAGE",
                    "updated_ts": "2010-07-22T10:53:48",
                    "usage_state": "770"
                  }
                ],
                "Total": "4757"
              }
            },
            "schema": {
              "properties": {
                "Next": {
                  "description": "Url to next page of  poles list. Null if No next page exist",
                  "format": "url",
                  "type": "string"
                },
                "Previous": {
                  "description": "Url to previous page of  poles list. Null if No previous page exist",
                  "format": "url",
                  "type": "string"
                },
                "Results": {
                  "description": "List of fetched  poles",
                  "items": {
                    "$ref": "#/definitions/Pole"
                  },
                  "type": "array"
                },
                "Total": {
                  "description": "Total number of  poles",
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "$ref": "#/responses/Http401"
          }
        },
        "security": [
          {
            "Token": []
          }
        ],
        "summary": "Get list of  poles",
        "tags": [
          "Pole"
        ]
      }
    }
  }
}
````