Single Muncipality and Forms

Get a single municipality with available forms

get

https://api.gemeindeconnect.ch/extensionhttps://api-dev.gemeindeconnect.ch/extension

/municipalities/{municipalityId}

Returns one municipality and the forms available for the municipality.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key required for server-to-server access.

Path parameters

municipalityIdinteger · int32Required

Unique identifier of the municipality.

Example: 303

Header parameters

x-correlation-idstringOptional

Optional correlation ID provided by the client. If not provided, the server will generate one.

Example: b7e2f9a0c8a14f3db8c7c5f4a1b2c3d4

Responses

200

Successful response

application/json

400

Invalid request

application/json

401

A valid API key (x-api-key) is required to access this resource.

application/json

403

Authenticated but not authorized to access this resource.

application/json

404

The specified municipality was not found.

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/municipalities/{municipalityId}

HTTPcURLJavaScriptPython

GET /extension/municipalities/{municipalityId} HTTP/1.1
Host: api.gemeindeconnect.ch
x-api-key: YOUR_API_KEY
Accept: */*

{
  "municipalityId": 303,
  "municipalityName": "Grenchen",
  "forms": [
    {
      "formId": "3c0c8705-37cc-4c59-80e7-387b0fe9c0af",
      "formName": {
        "de": "Niederlassungsbescheinigung bestellen"
      },
      "formDescription": {
        "de": "<p>Bestellen Sie hier Ihre Niederlassungsbescheinigung.</p>"
      },
      "status": "active",
      "tags": [
        "Einwohnerkontrolle",
        "GemeindeConnect final"
      ],
      "formUrl": "https://schwyz.cumuluspro.net/workflow-forms/303/3c0c8705-37cc-4c59-80e7-387b0fe9c0af"
    },
    {
      "formId": "72db1819-a7c2-4874-9fe2-bf6c821e8bad",
      "formName": {
        "de": "Adressauskunft bestellen"
      },
      "formDescription": {
        "de": "<p>Adressauskunft online bestellen.</p>"
      },
      "status": "inactive",
      "tags": [],
      "formUrl": "https://schwyz.cumuluspro.net/workflow-forms/303/72db1819-a7c2-4874-9fe2-bf6c821e8bad"
    }
  ]
}