Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Reference Data

Get Time Zones

Retrieves a list of time zones available on the system along with their relevant details. <br />With this endpoint, you can search for specific time zones, paginate results, and sort the data as needed.

get/v4/timezones

Query parameters

countryCodestring

A two-letter ISO 3166-1 alpha-2 code that represents a specific country. <br />This parameter is used to filter the list of time zones returned by the API, allowing users to retrieve only the time zones that are associated with the specified country.

searchTermstring

A string representing the term or keywords used to filter the list of time zones, helping users to narrow down the list based on their input.

pageSizeinteger

An integer that defines the maximum number of time zone records returned per page in the response. <br /> For instance, if pageSize is set to 20, the API will return up to 20 time zones in each response. <br />
<br /> <b>Note:</b> By default, this value is set to 100.

pageNumberinteger

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. <br /> For example, if <b>pageNumber</b> is set to 3, the API will return the results corresponding to the third page of locations based on the specified <b>pageSize</b>. <br />
<br /> <b>Note:</b> By default, this value is set to 1.

sortBy'TimezoneName' | 'Country' | 'CountryCode'

Sort By

A string specifying the field by which to organise the search results. <br />For instance, "TimeZoneName" could be used to sort countries alphabetically, arranging the results in a more user-friendly order. <br /> <br /><b>Note:</b> By default, this value is set to CountryCode. <br /> <br />Enum [TimeZoneName, Country, CountryCode]

sortDir'Ascending' | 'Descending'

Order Direction

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending". <br />For example, setting sortDir to "Ascending" while using "CountryName" as sortBy would arrange the countries from A to Z. <br /> <br /><b>Note:</b> By default, this value is set to Ascending. <br /> <br />Enum [Ascending, Descending]

Response

Returns a list of all the time zones for a given country.

TotalCountinteger required

An integer representing the total number of time zones matching the search criteria, regardless of pagination. <br />This information is useful for understanding the full scope of available results.

Example response

{
  "TimeZones": [
    {
      "TimezoneName": "Europe/Rome",
      "Country": "Italy",
      "CountryCode": "IT",
      "UTCOffset": "UTC+1"
    }
  ],
  "TotalCount": 1
}