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

> Operation is used to get a list of circuit. Available from product version 3.2.2.

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


## OpenAPI

````json GET /circuits/
{
  "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": {
    "/circuits/": {
      "get": {
        "description": "Operation is used to get a list of circuit. Available from product version 3.2.2.\n\nCircuits can be filtered by giving filtering parameters at HTTP querystring (see parameters).\n",
        "operationId": "getCircuits",
        "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": "https://keycom.example.com/api/v2/circuits/?limit=10&offset=10",
                "Previous": null,
                "Results": [
                  {
                    "areaCode": null,
                    "comments": "",
                    "contractLength": null,
                    "contractNumber": "",
                    "createdBy": "admin",
                    "createdTs": "2021-06-23",
                    "customer": null,
                    "directLength": null,
                    "id": "263334",
                    "identifier": "TP2",
                    "identifierAlt": "",
                    "importance": null,
                    "installationAddresses": [
                      "https://keycom.example.com/api/v2/circuitlocations/42875790/"
                    ],
                    "length": null,
                    "orderNumber": "",
                    "organisation": null,
                    "redundancy": null,
                    "sections": [
                      {
                        "constructionState": {
                          "availability_end_ts": null,
                          "availability_start_ts": null,
                          "available": "true",
                          "groupname": "KN_CONST_STATE",
                          "id": "6050",
                          "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
                          "logical_txt": "Valmis",
                          "num_value": "1.0",
                          "num_value2": "1.0",
                          "num_value3": null,
                          "num_value4": null,
                          "txt": "Ready"
                        },
                        "extraUsages": [
                          {
                            "customerUrl": "https://keycom.example.com/keyrns_core.apps.customer/customer/773/",
                            "extraUsage": {
                              "availability_end_ts": null,
                              "availability_start_ts": null,
                              "available": "true",
                              "groupname": "KN_EXTRAUSAGE",
                              "id": "232690",
                              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_EXTRAUSAGE/",
                              "logical_txt": "IPTV DSL-liittymälle",
                              "num_value": "2.0",
                              "num_value2": null,
                              "num_value3": null,
                              "num_value4": null,
                              "txt": "IPTV (Additional service to DSL)"
                            },
                            "information": "",
                            "name1": "a",
                            "name2": "b",
                            "name3": "c",
                            "name4": "d",
                            "pk": "1"
                          }
                        ],
                        "id": "3026741",
                        "listUrl": "https://keycom.example.com/api/v2/sections/",
                        "name": "0",
                        "usagePurpose": {
                          "availability_end_ts": null,
                          "availability_start_ts": null,
                          "available": "true",
                          "groupname": "USAGE",
                          "id": "14870",
                          "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/USAGE/",
                          "logical_txt": "15 Laajakaista PLUS",
                          "num_value": "15.0",
                          "num_value2": null,
                          "num_value3": null,
                          "num_value4": null,
                          "txt": "15 Laajakaista PLUS"
                        },
                        "usageState": {
                          "availability_end_ts": null,
                          "availability_start_ts": null,
                          "available": "true",
                          "groupname": "KN_USAGE_STATE",
                          "id": "6310",
                          "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_USAGE_STATE/",
                          "logical_txt": "Käytössä",
                          "num_value": "2.0",
                          "num_value2": "1.0",
                          "num_value3": null,
                          "num_value4": null,
                          "txt": "In use"
                        }
                      }
                    ],
                    "supercircuit": {
                      "id": "1",
                      "identifier": "SC-001",
                      "itemType": {
                        "availability_end_ts": null,
                        "availability_start_ts": null,
                        "available": "true",
                        "groupname": "SUPER_CIRCUIT_TYPE",
                        "id": "500",
                        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/SUPER_CIRCUIT_TYPE/",
                        "logical_txt": "Transport",
                        "num_value": "1.0",
                        "num_value2": null,
                        "num_value3": null,
                        "num_value4": null,
                        "txt": "Transport"
                      },
                      "networkType": {
                        "availability_end_ts": null,
                        "availability_start_ts": null,
                        "available": "true",
                        "groupname": "KN_NETWORK_TYPE",
                        "id": "502",
                        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_NETWORK_TYPE/",
                        "logical_txt": "Fiber",
                        "num_value": "1.0",
                        "num_value2": null,
                        "num_value3": null,
                        "num_value4": null,
                        "txt": "Fiber"
                      },
                      "state": {
                        "availability_end_ts": null,
                        "availability_start_ts": null,
                        "available": "true",
                        "groupname": "SUPER_CIRCUIT_STATE",
                        "id": "501",
                        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/SUPER_CIRCUIT_STATE/",
                        "logical_txt": "Active",
                        "num_value": "1.0",
                        "num_value2": null,
                        "num_value3": null,
                        "num_value4": null,
                        "txt": "Active"
                      }
                    },
                    "supercircuitOrderNo": "1",
                    "updatedBy": "example@keypro.fi",
                    "updatedTs": "2023-04-27"
                  },
                  {
                    "areaCode": null,
                    "comments": "",
                    "contractLength": null,
                    "contractNumber": "",
                    "createdBy": "admin",
                    "createdTs": "2021-07-07",
                    "customer": null,
                    "directLength": null,
                    "id": "269114",
                    "identifier": "TP2-TP3",
                    "identifierAlt": "",
                    "importance": null,
                    "installationAddresses": [],
                    "length": null,
                    "orderNumber": "",
                    "organisation": null,
                    "redundancy": null,
                    "sections": [
                      {
                        "constructionState": {
                          "availability_end_ts": null,
                          "availability_start_ts": null,
                          "available": "true",
                          "groupname": "KN_CONST_STATE",
                          "id": "6050",
                          "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
                          "logical_txt": "Valmis",
                          "num_value": "1.0",
                          "num_value2": "1.0",
                          "num_value3": null,
                          "num_value4": null,
                          "txt": "Ready"
                        },
                        "extraUsages": [],
                        "id": "3105141",
                        "listUrl": "https://keycom.example.com/api/v2/sections/",
                        "name": "",
                        "usagePurpose": null,
                        "usageState": {
                          "availability_end_ts": null,
                          "availability_start_ts": null,
                          "available": "true",
                          "groupname": "KN_USAGE_STATE",
                          "id": "6310",
                          "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_USAGE_STATE/",
                          "logical_txt": "Käytössä",
                          "num_value": "2.0",
                          "num_value2": "1.0",
                          "num_value3": null,
                          "num_value4": null,
                          "txt": "In use"
                        }
                      }
                    ],
                    "supercircuit": null,
                    "supercircuitOrderNo": null,
                    "updatedBy": "example@keypro.fi",
                    "updatedTs": "2023-04-27"
                  }
                ],
                "Total": "123456"
              }
            },
            "schema": {
              "properties": {
                "Next": {
                  "description": "Url to next page of circuits. Null if No next page exist",
                  "format": "url",
                  "type": "string"
                },
                "Previous": {
                  "description": "Url to previous page of circuits. Null if No previous page exist",
                  "format": "url",
                  "type": "string"
                },
                "Results": {
                  "description": "List of fetched circuits",
                  "items": {
                    "$ref": "#/definitions/Circuit"
                  },
                  "type": "array"
                },
                "Total": {
                  "description": "Total number of circuit",
                  "type": "integer"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "$ref": "#/responses/Http401"
          }
        },
        "security": [
          {
            "Token": []
          }
        ],
        "summary": "Get list of circuits",
        "tags": [
          "Circuit"
        ]
      }
    }
  }
}
````