Administrate

Version 2 (v2)

Filtering

The Administrate API provides a set of filters which are useful for requesting a restricted set of results to avoid further processing and reduce bandwidth. This allows the possiblity to return records between a set of dates, for example, or all those records that belong to a list of ids.

Available Filters

Name Operator Usage
Less than __lt attribute__lt=[value]
Less than or equal to __lte attribute__lte=[value]
Greater than __gt attribute__gt=[value]
Greater than or equal to __gte attribute__gte=[value]
Equals __eq attribute__eq=[value]
Belongs to __in attribute__in=value_1[,value_2]*
Does not belong to __notin attribute__notin=value_1[,value_2]*

Important

The commands ‘__in’ and ‘__notin’ take a comma separated list, such as 1,2,3 or foo,bar,smith with no spaces before or after the comma.

Date time filtering

Date time fields are required to be ISO compliant. Most fields are not time zone aware and hence need to be provided without an offset. Contrarily, time zone aware fields are required to have an offset. An example of both forms can be found below:

Date time ISO formats examples

Type Example
ISO datetime without offset 2017-12-20T18:00:00
ISO datetime with offset 2017-12-20T18:00:00+01:00

Ordering

You can order the results by using a query parameter of ‘_order=field’. To order by multiple fields, simply comma separate them: ‘_order=field1,field2’. To order in descending order, place a dash in front of the field name: ‘_order=-field1,field2’.

Example

curl -k -u <username>:<password> \
     https://YOUR-SUBDOMAIN.administrateapp.com/api/v2/crm/accounts?_order=first_name

Limiting

You can limit the results by using a query parameter of ‘_limit=N’ where N is an integer.

Example

curl -k -u <username>:<password> \
     https://YOUR-SUBDOMAIN.administrateapp.com/api/v2/crm/accounts?_limit=10