Get cities in DACH

GET/cities/

API version

v2

Request method

GET

Operation ID

leadfyndr-get-cities

---

Request

Responses

Format

application/json

Beschreibung

The list of cities.

Schema-Dokumentation

• Array[
• *object
  • citystring

    required
  • countrystring

    required
  • countystring
  • postCodestring

    required
]

Beispiel

Content-Type: application/json

[
  {
    "city": "string",
    "country": "string",
    "county": "string",
    "postCode": "string"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "city": {
        "type": "string"
      },
      "country": {
        "type": "string"
      },
      "county": {
        "type": "string"
      },
      "postCode": {
        "type": "string"
      }
    },
    "required": [
      "country",
      "postCode",
      "city"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/cities?input=string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.leadFyndr.getCities({
  "queryParameters": {
    "input": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\LeadFyndr\GetCities\GetCitiesRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetCitiesRequest())
  ->withInput("string");
$response = $client->leadFyndr()->getCities($request);

var_dump($response->getBody();