ContactQuery

Filter parameters to fetch a list of contacts

Fields

Field	Description
filter string	A SQL query that returns contact IDs Can be used to do arbitrary filtering. See the database documentation for contact for more information. Example value:`"select id from tm.contact where firstname = 'Ruben'"`
includearchived bool	If this parameter is true, archived items will be returned as well.
lastupdatesince timestamp	Only include contacts that have been updated since the given timestamp. Example value:`"2014-09-26 15:24:36"`
limit int	Limit results to at most the given amount of contacts. Example value:`100`
offset int	Skip the first X contacts. Example value:`100`
orderby string	Order by the given field. Supported values: `name`, `lastupdatets`, `createdts`. Example value:`"name"`
output string	Output format. Possible values: ids: Only fill the ID field minimal: A minimal set of order fields default: Return all order fields (also used when the output parameter is omitted) Example value:`"default"`
searchterm string	A text filter string. Matches against the contact name and contact details. Example value:`"John"`

Example

 1{
 2    "filter": "select id from tm.contact where firstname = 'Ruben'",
 3    "includearchived": false,
 4    "lastupdatesince": "2014-09-26 15:24:36",
 5    "limit": 100,
 6    "offset": 100,
 7    "orderby": "name",
 8    "output": "default",
 9    "searchterm": "John"
10}