Data types
The API returns and accepts JSON values, which can be strings in double quotes, numbers, objects, arrays, true or false, or null. Most programming languages have tools to parse this data. See Working with JSON for a few languages.
ID integers
Most Zendesk Support resources, such as tickets and users, are identified by the integer specified by the id
attribute of API responses. The term refers to the JSON numeric type, not a C-like int
data type.
The default numeric type in JavaScript, Ruby, Python, and PHP is sufficient to represent Zendesk Support ID integers.
If you use a static-typed language where integer types are declared explicitly, use a 64-bit integer type (signed is OK) for Zendesk Support ID integers.
For example, in Java or C#, use the long
type, not int
.
Time stamps
Time stamps use UTC time and are formatted as ISO 8601 strings. Example: "2015-04-16T09:14:57Z".
Some endpoints use Unix time, also known as Epoch or POSIX time. Example: "1455821369". See Unix time for more information.
Locales
Locales are returned and passed as strings. Example: "en-us".