Skip to main content

Tenant

A Tenant in this system represents an organization (e.g., Acme Inc.) that owns users, tours, and configurations. Public v2 endpoints use snake_case keys and are documented in the OpenAPI spec; highlights below.

Endpointsโ€‹

  • GET /api/v2/tenant โ€” returns the current authenticated tenant resource.
  • PATCH /api/v2/tenant โ€” JSON Merge Patch (RFC 7396). Omit fields to keep them unchanged.

Reading requires authentication; writing additionally requires the tenant:settings:update grant.

Payloadsโ€‹

Get (GET /api/v2/tenant)โ€‹

{
"name": "TenantA",
"language": "de",
"region": "AT",
"timezone": "Europe/Vienna",
"help_url": "https://help.example.com/tourfold",
"lock_version": 3
}

help_url is omitted when no custom link is configured; first-party frontends then open the platform documentation from the Help entry in the header menu.

Patch (PATCH /api/v2/tenant)โ€‹

Content-Type: application/merge-patch+json (application/json is accepted as an alias)

{
"name": "Acme Europe",
"language": "de-DE"
}

Set a custom Help link, or clear it again with an explicit null:

{
"help_url": "https://help.example.com/tourfold"
}
{
"help_url": null
}

No-op patch (keeps current value):

{}

Notes:

  • name must be a non-empty string with max length 255.
  • language must be a non-empty string with max length 10.
  • timezone must be a non-empty string with max length 50 and a valid IANA timezone identifier (for example Europe/Vienna).
  • region must be an ISO 3166-1 alpha-2 country code.
  • help_url is optional and clearable. When provided it must be an absolute http or https URL with max length 2048 and without embedded credentials (user:password@); an empty string is rejected with 422 Validation failed. Surrounding whitespace is trimmed and the scheme and host are lowercased before the value is stored and returned.
  • name: null is rejected with 422 Validation failed.
  • language: null, region: null and timezone: null are rejected with 422 Validation failed.
  • language and timezone are stored tenant preferences. They do not directly override the browser UI language.

Frontend-only timezone catalogโ€‹

For first-party frontend clients, timezone options are provided by:

  • GET /frontend/v2/frontend-configuration/timezones โ€” returns available IANA timezone identifiers.

Frontend-only language catalogโ€‹

For first-party frontend clients, language options are provided by:

  • GET /frontend/v2/frontend-configuration/languages โ€” returns currently supported tenant language identifiers.

Both frontend catalog endpoints are intended for internal frontend consumption and are not part of the public v2 API contract.