Time zones

IANA time zone names. Static reference data.

The object#

FieldTypeDescription
idread-onlyintegerIdentifier.
namestring(64)IANA zone name.

Endpoints#

GET/timezones 200403

List time zones.

Requires scope reference:read.

Parameters
NameInTypeNotes
namequerystringname. Partial match, case-insensitive.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
403insufficient_scopeToken lacks timezones:read.
curl \
  'https://acme.nolapro.com/!/api/v2/timezones' \
  -H 'Authorization: Bearer $NP_TOKEN'
GET/timezones/{id} 200404

Retrieve one record.

Requires scope reference:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/timezones/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "id": 1,
    "name": "America/New_York"
}