Tenant

Tenant management endpoints: retrieve tenant details

Get tenant details by id

get

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

/Tenant/{id}

Retrieve tenant details by id. The tenantId can be retrieved from the Cockpit.

Authorizations

BearerAuth

AuthorizationstringRequired

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

Path parameters

idinteger · int32Required

Tenant ID (municipality) to retrieve details for. Can be retrieved from the Cockpit.

Responses

200

OK

application/json

Represents tenant details as retrieved from the Digitale-Gemeinde Cockpit.

idstring · uuidRequired

Unique identifier (GUID) of the tenant record.

tenantIdinteger · int32Required

Numeric tenant ID (municipality ID). This is the tenant identifier used in the Cockpit.

tenantNamestringRequired

Human-readable name of the tenant. For example, the name of the municipality (Stadt Zürich).

401

Unauthorized

application/json

500

Internal server error

application/json

get

/Tenant/{id}

HTTPcURLJavaScriptPython

GET /core/Tenant/{id} HTTP/1.1
Host: api.gemeindeconnect.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "65727e7e-4a86-43b9-acc9-4292d87aa87b",
  "tenantId": 15,
  "tenantName": "Stadt Zürich"
}