Skip to main content

TimezonesResponse

Response from the timezones endpoint containing a list of timezone options and the server's local timezone.

server_timezonestringrequired

The IANA timezone key of the Journyx server's local timezone.

Example: America/Chicago
server_timezone_labelstringrequired

Human-readable display label for the server's local timezone, in the same format as the text field of timezone items.

Example: Central Time (UTC-06:00) - America/Chicago
timezones object[]required

List of available timezone options. Common timezones are listed first (sorted by ascending UTC offset, then IANA key), followed by all other timezones in the same order.

  • Array [
  • valuestringrequired

    The canonical IANA timezone key. This is the value that should be stored and sent back to the API in fields like default_timezone or the timezone field on entry sheet save requests.

    Example: America/Chicago
    textstringrequired

    Human-readable display label including the timezone's common name, current UTC offset, and IANA key. The UTC offset reflects the current DST state.

    Example: Central Time (UTC-06:00) - America/Chicago
    text_shortstringrequired

    Shorter display label with just the common name and UTC offset.

    Example: Central Time (UTC-06:00)
    abbrevstringrequired

    Standard timezone abbreviation (e.g. CST, CDT, EST). Reflects the current DST state.

    Example: CST
    commonbooleanrequired

    Whether this is a commonly used timezone. Common timezones are sorted first in the response for prominent display in the UI.

    Example: true
  • ]
  • TimezonesResponse
    {
    "server_timezone": "America/Chicago",
    "server_timezone_label": "Central Time (UTC-06:00) - America/Chicago",
    "timezones": [
    {
    "value": "America/Chicago",
    "text": "Central Time (UTC-06:00) - America/Chicago",
    "text_short": "Central Time (UTC-06:00)",
    "abbrev": "CST",
    "common": true
    }
    ]
    }