Form

Manage individual form instances: retrieve documents, submit form data, update document status, and search or count submitted forms.

Get form instance counts by form design and status

get

https://api.gemeindeconnect.ch/corehttps://api-test.gemeindeconnect.ch/core

/Form/count

Retrieve a summary of submitted form instances grouped by form design and status.

The return result can be used to determine how many form instances are with which status and which form design. An example use can be to display an overview for a user.

Authorizations

BearerAuth

AuthorizationstringRequired

Use the Authorization header with a Bearer JWT: Authorization: Bearer

Query parameters

tenantIdinteger · int32Required

Required to identify the tenant. The tenantId can be retrieved from the Cockpit.

Responses

200

OK

application/json

Summary for a form design: total counts for the form and an optional per‑status breakdown. Each FormNavigation object points to a reusable request you can use to fetch the actual instances.

idstring · nullableOptional

Form design GUID (same as formId).

namestring · nullableOptional

Human readable name of the form (e.g. 'Hauptwohnsitzbescheinigung').

countinteger · int32Optional

Total number of submitted form instances (across all statuses).

401

Unauthorized

application/json

500

Internal server error

application/json

get

/Form/count

HTTPcURLJavaScriptPython

GET /core/Form/count?tenantId=1 HTTP/1.1
Host: api.gemeindeconnect.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "16171dbd-a37f-4628-adfa-bc4e4ba9de81",
    "name": "Projektbeitragsgesuch",
    "count": 5,
    "request": {
      "formId": "16171dbd-a37f-4628-adfa-bc4e4ba9de81",
      "formStateConfigId": 0,
      "page": 0,
      "pageSize": 50
    },
    "formNavigations": [
      {
        "id": "16171dbd-a37f-4628-adfa-bc4e4ba9de81-Neu",
        "name": "Neu",
        "count": 2,
        "request": {
          "formId": "16171dbd-a37f-4628-adfa-bc4e4ba9de81",
          "status": "Neu",
          "formStateConfigId": 35,
          "page": 0,
          "pageSize": 50
        }
      },
      {
        "id": "16171dbd-a37f-4628-adfa-bc4e4ba9de81-InBearbeitung",
        "name": "In Bearbeitung",
        "count": 1,
        "request": {
          "formId": "16171dbd-a37f-4628-adfa-bc4e4ba9de81",
          "status": "In Bearbeitung",
          "formStateConfigId": 36,
          "page": 0,
          "pageSize": 50
        }
      },
      {
        "id": "16171dbd-a37f-4628-adfa-bc4e4ba9de81-Abgeschlossen",
        "name": "Abgeschlossen",
        "count": 2,
        "request": {
          "formId": "16171dbd-a37f-4628-adfa-bc4e4ba9de81",
          "status": "Abgeschlossen",
          "formStateConfigId": 37,
          "page": 0,
          "pageSize": 50
        }
      }
    ]
  }
]

Search submitted forms

post

https://api.gemeindeconnect.ch/corehttps://api-test.gemeindeconnect.ch/core

/Form/search

Search forms using the supplied criteria. Returns paged results of form data.

Authorizations

BearerAuth

AuthorizationstringRequired

Use the Authorization header with a Bearer JWT: Authorization: Bearer

Query parameters

tenantIdinteger · int32Required

Body

application/json

keywordstring · nullableOptional

Keyword to search in submitted forms. It can be a full or partial match of a Form Name or a Tag of a form.

formIdstring · nullableOptional

a formId to filter the search results. The formId is the GUID returned in the /Form/count endpoint as "id".

statusstring · nullableOptional

Status to filter the search results. E.g. "Neu", "In Bearbeitung", "Abgeschlossen".

pageinteger · int32Optional

Page number. If not provided, defaults to 0.

Default: 0

pageSizeinteger · int32Optional

Number of items per page. If not provided, defaults to 50.

Default: 50

orderBystring · nullableOptional

Field to order the results by. E.g. "submittedDate", "name".

orderByDirectionstring · enumOptionalPossible values:

Responses

200

OK

application/json

totalCountinteger · int32Optional

Total number of submitted forms available.

pageNumberinteger · int32Optional

Current page number.

pageSizeinteger · int32Optional

Number of forms per page.

401

Unauthorized

application/json

500

Internal server error

application/json

post

/Form/search

HTTPcURLJavaScriptPython

POST /core/Form/search?tenantId=1 HTTP/1.1
Host: api.gemeindeconnect.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "keyword": "text",
  "formId": "text",
  "status": "text",
  "page": 0,
  "pageSize": 50,
  "orderBy": "text",
  "orderByDirection": "Ascending"
}

{
  "data": [
    {
      "id": "a4c70dfd-1bc0-4a73-847d-4b620b50ca9a",
      "name": "Bestätigung der Kindesanerkennung bestellen ",
      "documentId": "1934912",
      "status": "Neu",
      "tenantId": 15,
      "formId": "2cf5e9a5-bb0b-41e1-bf71-9b75cb72897f",
      "tenantName": "Stadt Zürich",
      "submittedDate": "2025-09-02T13:42:02.7078251"
    }
  ],
  "totalCount": 1,
  "pageNumber": 1,
  "pageSize": 100
}

Get form details by documentId

get

https://api.gemeindeconnect.ch/corehttps://api-test.gemeindeconnect.ch/core

/Form/{formId}/data/{documentId}

Retrieve a specific document by documentId for the given form. Returns the document response payload.

Authorizations

BearerAuth

AuthorizationstringRequired

Use the Authorization header with a Bearer JWT: Authorization: Bearer

Path parameters

formIdstring · uuidRequired

Form design GUID. Can be retrieved from the /Form/count or Form/search endpoint.

documentIdstringRequired

Document ID Can be retrieved from the /Form/search endpoint and identifies a submitted form instance.

Query parameters

tenantIdinteger · int32Required

Required to identify the tenant. The tenantId can be retrieved from the Cockpit.

Responses

200

OK

application/json

statestring · nullableOptional

401

Unauthorized

application/json

500

Internal server error

application/json

get

/Form/{formId}/data/{documentId}

HTTPcURLJavaScriptPython

GET /core/Form/{formId}/data/{documentId}?tenantId=1 HTTP/1.1
Host: api.gemeindeconnect.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fields": [
    {
      "tabName": "text",
      "name": "text",
      "value": "text"
    }
  ],
  "state": "text"
}

Update form instance field values by documentId

patch

https://api.gemeindeconnect.ch/corehttps://api-test.gemeindeconnect.ch/core

/Form/{formId}/data/{documentId}

Update form field values. Only submit fields that need to be updated. Important that the name of the field matches the name in the form design as retrieved in the get /Form/{formId}/document/{documentId} endpoint.

Authorizations

BearerAuth

AuthorizationstringRequired

Use the Authorization header with a Bearer JWT: Authorization: Bearer

Path parameters

formIdstring · uuidRequired

Form design GUID. Can be retrieved from the /Form/count or Form/search endpoint.

documentIdstringRequired

Document ID Can be retrieved from the /Form/search endpoint and identifies a submitted form instance.

Query parameters

tenantIdinteger · int32Required

Required to identify the tenant. The tenantId can be retrieved from the Cockpit.

Body

application/json

Request payload to update form instance field values.

statestring · nullableOptional

Optional new state (status) to set for the form instance. If provided, the form instance status will be updated.

Example: In Bearbeitung

Responses

200

OK

application/json

statestring · nullableOptional

401

Unauthorized

application/json

500

Internal server error

application/json

patch

/Form/{formId}/data/{documentId}

HTTPcURLJavaScriptPython

PATCH /core/Form/{formId}/data/{documentId}?tenantId=1 HTTP/1.1
Host: api.gemeindeconnect.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "state": "In Bearbeitung",
  "fields": [
    {
      "tabName": "Section 1",
      "name": "FirstName-6e8cda36-ff0c-4b29-8689-6e1d22e63ea6",
      "value": "John"
    }
  ]
}

{
  "fields": [
    {
      "tabName": "text",
      "name": "text",
      "value": "text"
    }
  ],
  "state": "text"
}

Upload a file to a file upload field in a form instance

patch

https://api.gemeindeconnect.ch/corehttps://api-test.gemeindeconnect.ch/core

/Form/{formId}/data/{documentId}/upload

Upload a file to a file upload field in a form instance. The file will be added to the specified tab and field name.

Authorizations

BearerAuth

AuthorizationstringRequired

Use the Authorization header with a Bearer JWT: Authorization: Bearer

Path parameters

formIdstringRequired

documentIdstringRequired

Query parameters

tenantIdinteger · int32Optional

Body

application/json

tabnamestring · nullableOptional

namestring · nullableOptional

fileContentstring · nullableOptional

Responses

200

OK

No content

patch

/Form/{formId}/data/{documentId}/upload

HTTPcURLJavaScriptPython

PATCH /core/Form/{formId}/data/{documentId}/upload HTTP/1.1
Host: api.gemeindeconnect.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "tabname": "text",
  "name": "text",
  "fileContent": "text"
}

200

OK

No content