About this endpoint
What it does
Converts or plans time across time zones using DST-aware timezone data. The request body supports three modes via mode: convert, meeting, and now.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| mode | String | No | convert | meeting | now |
| to_tz | String | No | Target IANA zone(s), comma-separated. Used in convert mode. |
| zones | String | No | Comma-separated IANA zones. Used in meeting and now modes. |
| from_tz | String | No | Source IANA timezone. Used in convert mode. |
| work_end | Integer | No | Working-day end hour, 1-24. Used in meeting mode. Default: 17. |
| now_epoch | Integer | No | Unix seconds to pin the reference instant for now and meeting modes. Default: actual current time. |
| work_start | Integer | No | Working-day start hour, 0-23. Used in meeting mode. Default: 9. |
| datetime_str | String | No | Local datetime in ISO 8601 format. Used in convert mode. |
Response
Returns a JSON object with utc, mode, source, and targets top-level fields. utc and source are objects with timezone-converted date/time details, while targets is an object that can contain per-zone objects such as Asia/Tokyo and Europe/London, each with the same date/time metadata fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| utc | Object | No | UTC-formatted conversion details: date, time, is_dst, weekday, datetime, utc_offset, tz_abbreviation, utc_offset_minutes. |
| mode | String | No | The mode used for the operation. |
| source | Object | No | Source timezone details: tz, date, time, is_dst, weekday, datetime, utc_offset, tz_abbreviation, utc_offset_minutes. |
| targets | Object | No | Target timezone details keyed by zone name. The schema defines Asia/Tokyo and Europe/London, each with date, time, is_dst, weekday, datetime, utc_offset, tz_abbreviation, and utc_offset_minutes. |
Notes
The request schema does not mark any body fields as required, so callers should supply the fields that match the chosen mode. The response schema also only defines Asia/Tokyo and Europe/London under targets; other zones are not documented in the schema.