> ## 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 Telecom areas

> Operation is used to get a list of Telecom areas. Available from product version 3.2.8.

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


## OpenAPI

````json GET /telecom-areas/
{
  "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": {
    "/telecom-areas/": {
      "get": {
        "description": "Operation is used to get a list of Telecom areas. Available from product version 3.2.8.\n\nTelecom areas can be filtered by giving filtering parameters at HTTP querystring (see parameters).\n",
        "operationId": "getTelecomAreaList",
        "parameters": [
          {
            "$ref": "#/parameters/offsetParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          },
          {
            "$ref": "#/parameters/filterParam"
          },
          {
            "$ref": "#/parameters/orderParam"
          }
        ],
        "responses": {
          "200": {
            "description": "A result response object",
            "examples": {
              "application/json": {
                "Next": "https://example.keycom.fi/api/v2/telecom-areas/?limit=10&offset=10&orderby=-id",
                "Previous": null,
                "Results": [
                  {
                    "areaSize": "1044.59",
                    "createdBy": "user",
                    "createdTs": "2020-01-02T11:26:58",
                    "exchangeArea": {
                      "id": "5250",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "00000"
                    },
                    "id": "3323090",
                    "location": "SRID=3067;POLYGON Z ((371969.1377000000211410 6845420.5158000001683831 0.0000000000000000, 372043.8693000000203028 6845430.8865000000223517 0.0000000000000000, 372000.4763099499978125 6845452.8206356000155210 0.0000000000000000, 371969.1377000000211410 6845420.5158000001683831 0.0000000000000000))",
                    "name": "dwcxdwc",
                    "perimeter": "169.08",
                    "remarks": "",
                    "telecomAreaType": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": "true",
                      "groupname": "TELECOM_AREA_TYPE",
                      "id": "4535678",
                      "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
                      "logical_txt": "MSM TYPE",
                      "num_value": null,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "MSM TYPE"
                    },
                    "updatedBy": "user",
                    "updatedTs": "2020-01-02T11:27:45"
                  },
                  {
                    "areaSize": "5123.58",
                    "createdBy": "user",
                    "createdTs": "2019-04-15T17:08:09",
                    "exchangeArea": {
                      "id": "18450",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "11"
                    },
                    "id": "2169430",
                    "location": "SRID=3067;POLYGON Z ((422904.2042433799942955 6968625.7661052001640201 0.0000000000000000, 422888.5938351399963722 6968550.8890623003244400 0.0000000000000000, 422963.7354612299823202 6968527.3411584002897143 0.0000000000000000, 422949.9771353299729526 6968621.5327741997316480 0.0000000000000000, 422904.2042433799942955 6968625.7661052001640201 0.0000000000000000))",
                    "name": "ABC",
                    "perimeter": "296.39",
                    "remarks": "",
                    "telecomAreaType": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": "true",
                      "groupname": "TELECOM_AREA_TYPE",
                      "id": "1111117",
                      "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
                      "logical_txt": "aaaa",
                      "num_value": null,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "aaaa"
                    },
                    "updatedBy": "user",
                    "updatedTs": "2019-04-15T17:08:09"
                  },
                  {
                    "areaSize": "36682.23",
                    "createdBy": "user",
                    "createdTs": "2019-02-05T12:28:44",
                    "exchangeArea": {
                      "id": "12450",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "testi"
                    },
                    "id": "1869030",
                    "location": "SRID=3067;POLYGON Z ((590532.3079673299798742 6785484.7543147001415491 0.0000000000000000, 590823.3494768299860880 6785548.2542804004624486 0.0000000000000000, 590812.7661492100451142 6785458.2959957001730800 0.0000000000000000, 590574.6412777999648824 6785310.1294090002775192 0.0000000000000000, 590532.3079673299798742 6785484.7543147001415491 0.0000000000000000))",
                    "name": "test tasdasdasd",
                    "perimeter": "848.61",
                    "remarks": "",
                    "telecomAreaType": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": "true",
                      "groupname": "TELECOM_AREA_TYPE",
                      "id": "24652908",
                      "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
                      "logical_txt": "AAAB",
                      "num_value": null,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "AAAB"
                    },
                    "updatedBy": "user",
                    "updatedTs": "2019-02-05T12:28:44"
                  },
                  {
                    "areaSize": "81890.99",
                    "createdBy": "user",
                    "createdTs": "2018-11-27T10:37:55",
                    "exchangeArea": {
                      "id": "2870",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "foobar"
                    },
                    "id": "1727830",
                    "location": "SRID=3067;POLYGON Z ((463933.8995984499924816 6699072.4838843997567892 0.0000000000000000, 463908.7641953600104898 6699040.7339016003534198 0.0000000000000000, 463902.1496156000066549 6698979.8797677997499704 0.0000000000000000, 463937.8683463099878281 6698887.2756511000916362 0.0000000000000000, 463945.8058420200250112 6698874.0464915996417403 0.0000000000000000, 464033.1182948700152338 6698858.1715000998228788 0.0000000000000000, 464099.2640924900188111 6698851.5569203998893499 0.0000000000000000, 464121.7536636799923144 6698867.4319118000566959 0.0000000000000000, 464137.6286551000084728 6698961.3589444002136588 0.0000000000000000, 464161.4411422500270419 6698998.4005910996347666 0.0000000000000000, 464182.6077974800136872 6699016.9214144004508853 0.0000000000000000, 464199.8057048600167036 6699055.2859770003706217 0.0000000000000000, 464213.0348643800243735 6699112.1713629998266697 0.0000000000000000, 464219.6494441499817185 6699139.9525979999452829 0.0000000000000000, 464238.1702674800180830 6699192.8692361004650593 0.0000000000000000, 464006.6599758299998939 6699220.6504710996523499 0.0000000000000000, 463985.4933205900015309 6699191.5463201003149152 0.0000000000000000, 463982.8474886899930425 6699147.8900937000289559 0.0000000000000000, 463951.0975058299954981 6699098.9422035003080964 0.0000000000000000, 463998.7224801100092009 6699065.8693046998232603 0.0000000000000000, 463985.4933205900015309 6699049.9943132000043988 0.0000000000000000, 463933.8995984499924816 6699072.4838843997567892 0.0000000000000000))",
                    "name": "TEST",
                    "perimeter": "1257.79",
                    "remarks": "",
                    "telecomAreaType": null,
                    "updatedBy": "user",
                    "updatedTs": "2018-11-27T10:37:55"
                  },
                  {
                    "areaSize": "959.33",
                    "createdBy": "user",
                    "createdTs": "2018-08-15T15:15:15",
                    "exchangeArea": {
                      "id": "5250",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "00000"
                    },
                    "id": "1248870",
                    "location": "SRID=3067;POLYGON Z ((638326.8935000000055879 6946295.5102000003680587 0.0000000000000000, 638305.6029000000562519 6946324.4702000003308058 0.0000000000000000, 638343.7456036099465564 6946362.7056825999170542 0.0000000000000000, 638326.8935000000055879 6946295.5102000003680587 0.0000000000000000))",
                    "name": "Noljakankaari Test2",
                    "perimeter": "159.23",
                    "remarks": "",
                    "telecomAreaType": null,
                    "updatedBy": "user",
                    "updatedTs": "2018-08-15T15:15:15"
                  },
                  {
                    "areaSize": "1258326.66",
                    "createdBy": "user",
                    "createdTs": "2018-05-29T14:28:41",
                    "exchangeArea": {
                      "id": "2090",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "Test"
                    },
                    "id": "905690",
                    "location": "SRID=3067;POLYGON Z ((459067.4759319599834271 6706153.7079287003725767 0.0000000000000000, 459967.0587795099709183 6706550.5827144002541900 0.0000000000000000, 460760.8083508900017478 6705836.2081001996994019 0.0000000000000000, 459967.0587795099709183 6705254.1250812001526356 0.0000000000000000, 459305.6008033700054511 6705558.3957502003759146 0.0000000000000000, 459067.4759319599834271 6706153.7079287003725767 0.0000000000000000))",
                    "name": "test",
                    "perimeter": "4404.68",
                    "remarks": "",
                    "telecomAreaType": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": "true",
                      "groupname": "TELECOM_AREA_TYPE",
                      "id": "4535678",
                      "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
                      "logical_txt": "a",
                      "num_value": null,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "a"
                    },
                    "updatedBy": "user",
                    "updatedTs": "2018-05-29T14:28:41"
                  },
                  {
                    "areaSize": "284450.15",
                    "createdBy": "user",
                    "createdTs": "2017-05-17T10:46:01",
                    "exchangeArea": {
                      "id": "21650",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "testt"
                    },
                    "id": "40870",
                    "location": "SRID=3067;POLYGON Z ((568944.6757999999681488 6882913.0307999998331070 0.0000000000000000, 569596.3466000000480562 6882878.1245999997481704 0.0000000000000000, 569596.8789000000106171 6882495.6913999998942018 0.0000000000000000, 568833.5993000000016764 6882494.6278999997302890 0.0000000000000000, 568944.6757999999681488 6882913.0307999998331070 0.0000000000000000))",
                    "name": "1",
                    "perimeter": "2232.11",
                    "remarks": "1",
                    "telecomAreaType": null,
                    "updatedBy": "user",
                    "updatedTs": "2017-05-17T10:46:01"
                  },
                  {
                    "areaSize": "67405.39",
                    "createdBy": "user",
                    "createdTs": "2017-03-15T07:21:56",
                    "exchangeArea": {
                      "id": "21250",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "xtest"
                    },
                    "id": "40070",
                    "location": "SRID=3067;POLYGON Z ((568688.5818999999901280 6882956.8223000001162291 0.0000000000000000, 568352.1676000000443310 6882961.8449999997392297 0.0000000000000000, 568357.1944000000366941 6882763.7520000003278255 0.0000000000000000, 568715.2957000000169501 6882766.9282999997958541 0.0000000000000000, 568688.5818999999901280 6882956.8223000001162291 0.0000000000000000))",
                    "name": "1",
                    "perimeter": "1084.92",
                    "remarks": "",
                    "telecomAreaType": {
                      "availability_end_ts": null,
                      "availability_start_ts": null,
                      "available": "true",
                      "groupname": "TELECOM_AREA_TYPE",
                      "id": "7230982",
                      "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
                      "logical_txt": "BBBH",
                      "num_value": null,
                      "num_value2": null,
                      "num_value3": null,
                      "num_value4": null,
                      "txt": "BBBH"
                    },
                    "updatedBy": "user",
                    "updatedTs": "2017-03-15T07:21:56"
                  },
                  {
                    "areaSize": "170666.48",
                    "createdBy": "user",
                    "createdTs": "2017-03-13T07:19:50",
                    "exchangeArea": {
                      "id": "20850",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "ktest"
                    },
                    "id": "39670",
                    "location": "SRID=3067;POLYGON Z ((568116.5389000000432134 6881887.1582000004127622 0.0000000000000000, 568557.1565999999875203 6881931.0646000001579523 0.0000000000000000, 568692.0428000000538304 6881580.3695000000298023 0.0000000000000000, 568079.5148000000044703 6881593.0598999997600913 0.0000000000000000, 568116.5389000000432134 6881887.1582000004127622 0.0000000000000000))",
                    "name": "1",
                    "perimeter": "1728.32",
                    "remarks": "",
                    "telecomAreaType": null,
                    "updatedBy": "user",
                    "updatedTs": "2017-03-13T07:19:50"
                  },
                  {
                    "areaSize": "214432.02",
                    "createdBy": "user",
                    "createdTs": "2017-01-31T12:16:40",
                    "exchangeArea": {
                      "id": "20450",
                      "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
                      "name": "testit1"
                    },
                    "id": "38870",
                    "location": "SRID=3067;POLYGON Z ((506086.8348000000114553 7144981.2413999997079372 0.0000000000000000, 506072.0252999999793246 7144607.2713000001385808 0.0000000000000000, 506651.2273000000277534 7144598.2828999999910593 0.0000000000000000, 506639.0602000000071712 7144981.7740000002086163 0.0000000000000000, 506086.8348000000114553 7144981.2413999997079372 0.0000000000000000))",
                    "name": "1",
                    "perimeter": "1890.21",
                    "remarks": "",
                    "telecomAreaType": null,
                    "updatedBy": "user",
                    "updatedTs": "2017-01-31T12:16:40"
                  }
                ],
                "Total": "114"
              }
            },
            "schema": {
              "properties": {
                "Next": {
                  "description": "Url to next page of Telecom areas data. Null if No next page exist",
                  "format": "url",
                  "type": "string"
                },
                "Previous": {
                  "description": "Url to previous page of Telecom areas data. Null if No previous page exist",
                  "format": "url",
                  "type": "string"
                },
                "Results": {
                  "description": "A list of fetched Telecom areas.",
                  "items": {
                    "$ref": "#/definitions/TelecomArea"
                  },
                  "type": "array"
                },
                "Total": {
                  "description": "Total number of Telecom areas",
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "$ref": "#/responses/Http401"
          }
        },
        "security": [
          {
            "Token": []
          }
        ],
        "summary": "Get list of Telecom areas",
        "tags": [
          "Telecom Area"
        ]
      }
    }
  }
}
````