Types

Date and Time

All dates and times should be represented in the ISO 8601 date/time format. The time element is optional.

Example dates in ISO 8601 format:

Date and TimeISO 8601 Representation
May 6th, 2011 at 5pm UTC2011-05-06T17:00Z
May 6th, 2011 at 3:30am PDT2011-05-06T03:30-07
May 6th, 2011 at midnight (time is optional)2011-05-06

Boolean Values

The following values can be used to represent true and false. These values are not case sensitive.

ValueAcceptable String Representation
true1, true
false0, false

Time Zones

One of the following strings:

Abu Dhabi
Adelaide
Alaska
Almaty
American Samoa
Amsterdam
Arizona
Astana
Athens
Atlantic Time (Canada)
Auckland
Azores
Baghdad
Baku
Bangkok
Beijing
Belgrade
Berlin
Bern
Bogota
Brasilia
Bratislava
Brisbane
Brussels
Bucharest
Budapest
Buenos Aires
Cairo
Canberra
Cape Verde Is.
Caracas
Casablanca
Central America
Central Time (US & Canada)
Chennai
Chihuahua
Chongqing
Copenhagen
Cuiaba
Darwin
Dhaka
Dublin
Eastern Time (US & Canada)
Edinburgh
Ekaterinburg
Fiji
Georgetown
Greenland
Guadalajara
Guam
Hanoi
Harare
Hawaii
Helsinki
Hobart
Hong Kong
Indiana (East)
International Date Line West
Irkutsk
Islamabad
Istanbul
Jakarta
Jerusalem
Kabul
Kamchatka
Karachi
Kathmandu
Kolkata
Krasnoyarsk
Kuala Lumpur
Kuwait
Kyiv
La Paz
Lima
Lisbon
Ljubljana
London
Madrid
Magadan
Marshall Is.
Mazatlan
Melbourne
Mexico City
Mid-Atlantic
Midway Island
Minsk
Monrovia
Monterrey
Moscow
Mountain Time (US & Canada)
Mumbai
Muscat
Nairobi
New Caledonia
New Delhi
Newfoundland
Novosibirsk
Nuku'alofa
Osaka
Pacific Time (US & Canada)
Paris
Perth
Port Moresby
Prague
Pretoria
Quito
Rangoon
Riga
Riyadh
Rome
Samoa
Santiago
Sapporo
Sarajevo
Saskatchewan
Seoul
Singapore
Skopje
Sofia
Solomon Is.
Sri Jayawardenepura
St. Petersburg
Stockholm
Sydney
Taipei
Tallinn
Tashkent
Tbilisi
Tehran
Tijuana
Tokelau Is.
Tokyo
UTC
Ulaan Bataar
Urumqi
Vienna
Vilnius
Vladivostok
Volgograd
Warsaw
Wellington
West Central Africa
Yakutsk
Yerevan
Zagreb

Object

Object types are a JSON object.

Array

Array types are used to represent a list of values.

Example array values for the include parameter on a GET request:

ValuesQuery String Representation
contact_methodsinclude[]=contact_methods
contact_methods, notification_rulesinclude[]=contact_methods&include[]=notification_rules

String

String types are a sequence of UTF-8 characters.

Integer

Integer types are a number without a fractional or decimal component.