# Timezone

## API actions

API path: `/timezone`.

### list

Information about all supported timezones for the specified locale. Does not require user authorization.

#### parameter

| name   | description     | type                                                        |
| ------ | --------------- | ----------------------------------------------------------- |
| locale | Name of locale. | [enum](/docs/navixy-api/user-api/backend-api.md#data-types) |

#### Example

cURL

```sh
curl -X POST 'https://api.eu.navixy.com/v2/timezone/list' \
    -H 'Content-Type: application/json' \
    -d '{"locale": "En-en"}'
```

#### Response

```json
{
  "success": true,
  "list": [
    {
      "zone_id": "Australia/Sydney",
      "description": "Sydney",
      "base_offset": 10.0,
      "dst_offset": 1,
      "country_code": "AU",
      "alt_ids": ["Australia/ACT", "Australia/Canberra", "Australia/NSW"]
    }
  ]
}
```

* `zone_id` - string. Timezone ID, which is used throughout the API.
* `description` - string. Localized description of the timezone.
* `base_offset` - double. Base timezone offset in hours, e.g. 10 means UTC +10. May be negative or fractional!
* `dst_offset` - int. DST offset in hours (0 if no DST rules for this timezone).
* `country_code` - string. ISO country code for the timezone.
* `alt_ids` - string array. List of strings, optional, alternative timezone IDs.

#### Errors

* [General](/docs/navixy-api/user-api/backend-api/errors.md#error-codes) types only.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/timezone.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.