---
updatedAt: 2025-05-21T09:37:30.000Z
agentTools:
  projectIndex: https://toursolver.readme.io/llms.txt
---

# List sub keys

SubKeys will be filtered to return only the ones which name contains the submitted string

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "servers": [
    {
      "url": "https://api.geoconcept.com/tsapi",
      "description": "Production",
      "variables": {}
    }
  ],
  "info": {
    "contact": {
      "email": "support@nomadia-group.com",
      "name": "Nomadia Group",
      "url": "https://www.nomadia-group.com/contact/"
    },
    "description": "Web APIs for TourSolver.",
    "title": "TourSolver API",
    "version": "2.0"
  },
  "tags": [
    {
      "description": "Manage your api sub keys",
      "name": "Sub key"
    }
  ],
  "paths": {
    "/listSubKeys": {
      "get": {
        "description": "SubKeys will be filtered to return only the ones which name contains the submitted string",
        "operationId": "listSubKeys",
        "parameters": [
          {
            "in": "query",
            "name": "nameContains",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubKeyResult"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SubKeyResult"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SubKeyResult"
                }
              }
            },
            "description": "SubKeyResult"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ],
        "servers": [
          {
            "description": "Production",
            "url": "https://api.geoconcept.com/tsapi",
            "variables": {}
          }
        ],
        "summary": "List sub keys",
        "tags": [
          "Sub key"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "SubKey": {
        "type": "object",
        "description": "Api sub key definition",
        "properties": {
          "creationDate": {
            "type": "string",
            "format": "date-time"
          },
          "creditResetDate": {
            "type": "string",
            "format": "date-time",
            "description": "Credits usage are fully reset after 24 hours. Reset is done only when an\noptimization is started. When the first optimization of the period is\nstarted, creditResetDate is set to now+24h. This date is reset only when\nstarting a new optimization and when creditResetDate is in the past."
          },
          "creditsPerDay": {
            "type": "integer",
            "format": "int64",
            "description": "Max usable credits per day. It must be positive if useCredits = true "
          },
          "description": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean",
            "description": "If false, using this subkey will result in a 403 response."
          },
          "expirationDate": {
            "type": "string",
            "format": "date-time",
            "description": "Subkey expiration date. Using this subkey after this date will result in a 403 response."
          },
          "key": {
            "type": "string",
            "description": "Read only value, it will be generated automatically"
          },
          "modificationDate": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string",
            "description": " This name can be used to filter the list of subKeys  "
          },
          "remainingCredits": {
            "type": "integer",
            "format": "int64",
            "description": "Number of remaining credits (if used). This value is decreased after each\noptimization. It will be reset to \"creditsPerDay\" value after 24 hours.\nThe reset action is triggered by a new optimization launch if\ncreditResetDate is in the past."
          },
          "totalUsedCredits": {
            "type": "integer",
            "format": "int64",
            "description": "Read only value, incremented for each optimization."
          },
          "useCredits": {
            "type": "boolean",
            "description": "If true, creditsParDay must be positive"
          }
        }
      },
      "SubKeyResult": {
        "type": "object",
        "properties": {
          "errCode": {
            "type": "string",
            "description": "Error code",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9",
              "10",
              "11",
              "12",
              "13",
              "14",
              "100",
              "101",
              "102",
              "103",
              "104",
              "105",
              "106",
              "107",
              "108",
              "109",
              "110",
              "111",
              "112",
              "113",
              "114",
              "115",
              "116",
              "200",
              "201",
              "300",
              "301",
              "400",
              "401",
              "500",
              "501",
              "502",
              "600",
              "601",
              "602",
              "603",
              "604",
              "1000",
              "1001",
              "1002",
              "1003",
              "1004",
              "1006",
              "1007",
              "1008",
              "2000",
              "2001",
              "2002",
              "2003",
              "2004",
              "2005",
              "2006",
              "2007",
              "2008",
              "2009",
              "2010",
              "2011",
              "2021",
              "2022",
              "2023",
              "2024",
              "2025",
              "2026",
              "2027",
              "2028",
              "2029",
              "2030",
              "2031",
              "3000",
              "3001",
              "3002",
              "4000",
              "4001",
              "4002",
              "5000",
              "5001",
              "5002",
              "5003",
              "6000"
            ]
          },
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "status": {
            "type": "string",
            "description": "OK or ERROR",
            "enum": [
              "OK",
              "ERROR"
            ]
          },
          "subKeys": {
            "type": "array",
            "description": "list of subKeys",
            "items": {
              "$ref": "#/components/schemas/SubKey"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "apiKey": {
        "description": "The api key can be passed through an header or in the query.",
        "in": "header",
        "name": "apiKey",
        "type": "apiKey"
      }
    }
  }
}
```