developers API Documentation

Data types

Name	Notes	Examples
boolean	(true or false) or (1 or 0) or (t or f)	true
integer	A positive or negative whole number	1
string	Limit of 255 characters	This is a string
text	Unlimited number of characters	This is some text.
date	%Y-%m-%d details	2013-05-22
datetime	%Y-%m-%d %H:%M:%S details	2013-05-22 06:46:26
datetime range	see bellow

---

Date format explanation

Symbol	Definition	Expected Range
%Y	Four digit year	1969..2100
%m	Two digit month	01..12
%d	Two digit day of month (01..32)	01..32
%H	Two digit hour of day (00..23)	00..23
%M	Two digit minute of day	00..59
%S	Two digit seconds of day	00..59

---

Datetime range explanation

Fields with datetime range expect a from_date or to_date or both in the query.

from_date	things that have the date at or after from_date
to_date	things that have the date at or before to_date

Examples

/deals.json?conditions[deal_created][from_date]=2011-01-01

This example will list all the deals that were created after 2011-01-01

/deals.json?conditions[deal_created][from_date]=2011-01-01&conditions[deal_created][to_date]=2012-01-01

This example will list all the deals that were created after 2011-01-01 and before 2012-01-01

/calendar_entries.json?conditions[when][from_date]=2011-01-01&conditions[when][to_date]=2012-01-01

This example will list all the calendar entries that take place 2011-01-01 and before 2012-01-01

---