Timezone
API call to get information about all supported timezones for the specified locale.
API actions
API path: panel/timezone.
This is the only Admin Panel operation that requires no authentication and no permissions.
List every time zone the platform supports, with localized descriptions.
This operation requires no authentication and no permissions.
Only zones under the Africa, America, Asia, Atlantic, Australia, Europe, Indian, and Pacific prefixes are returned, and only those for which a country code can be resolved. Verified live: 405 zones on the European platform.
Locale used for the description of each zone.
enSupported time zones
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.
Error response object
POST /v2/panel/timezone/list HTTP/1.1
Host: api.eu.navixy.com
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"locale": "en"
}{
"success": true,
"list": [
{
"zone_id": "America/Tijuana",
"description": "Tijuana",
"base_offset": -8,
"dst_offset": 1,
"country_code": "MX",
"alt_ids": [
"America/Ensenada",
"America/Santa_Isabel"
]
}
]
}The zone_id value is the identifier used wherever the API accepts a time zone, including default_user_time_zone in service settings.
Errors
General types only.
Last updated
Was this helpful?