Planfix API: contact filters
From Planfix
Contact filters are set with the following set of parameters:
- type - numeric identifier of the filter
- operator - filter operator, one of the values from the list (equal, notequal, gt, lt) different filters may have different available operators.
- value - filter value, can be a string, number or complex object, depending on the type of filter
- field - identifier of the custom field, for filters by custom fields
| Type | Name | Operators | Value format |
|---|---|---|---|
| 12 | Creation date |
|
object : <value>
<datetype></datetype>
<datevalue></datevalue>
<datefrom></datefrom>
<dateto></dateto>
</value>datetype accepts the following values:
examples: <value>
<datetype>thisweek</datetype>
</value><value>
<datetype>anotherperiod</datetype>
<datefrom>01-01-2015</datefrom>
<dateto>01-02-2015</dateto>
</value> |
| 4223 | Birth date (considering the year) | ||
| 4011 | Birth date (without considering the year) | ||
| 4213 | Counterparty in tasks with last activity | ||
| 4219 | Counterparty without tasks with last activity | ||
| 4214 | Participates in tasks with last activity | ||
| 4220 | Does not participate in tasks with last activity | ||
| 4103 | Custom field type Date | ||
| 1 | Added by |
|
int : employee identifier |
| 2 | Supervisor | ||
| 47 | Available to user | ||
| 48 | Can be edited by user | ||
| 4108 | Custom field of Contact type | ||
| 4109 | Custom field of Employee type | ||
| 4112 | Custom field of Group, employee, contact type | ||
| 4113 | Custom field of Employees list type | ||
| 4006 | Is a company |
|
int - 1 |
| 4007 | Is a contact | ||
| 4010 | With access to Planfix | ||
| 4012 | Can be a task participant | ||
| 4017 | Cannot be a task participant | ||
| 4013 | Can be a task counterparty | ||
| 4018 | Cannot be a task counterparty | ||
| 4201 | Counterparty without active tasks | ||
| 4202 | Does not participate in active tasks | ||
| 4203 | Counterparty with active tasks | ||
| 4204 | Participates in active tasks | ||
| 4205 | Counterparty in overdue tasks | ||
| 4206 | Participates in overdue tasks | ||
| 4001 | Contact's first or last name / company name |
|
string - contains / does not contain filter |
| 4002 | Position | ||
| 4003 | Phone | ||
| 4004 | Address | ||
| 4005 | |||
| 4221 | Additional email | ||
| 4014 | Contact name / Company name | ||
| 4015 | Contact's last name | ||
| 4101 | Custom field of String type | ||
| 4102 | Custom field of Number type |
|
int |
| 4105 | Custom field type Checkbox |
|
int - 1 / 0 |
| 4106 | Custom field type List |
|
string |
| 4107 | Custom field type Directory |
|
int - entry identifier |
| 4114 | Custom field type Set of directory entries |
|
int - entry identifier, for condition by several records - identifiers through ; (semicolon) |
| 4111 | Custom field type Set of values |
|
string -value, for condition by several values - values through ; (semicolon) |
| 4008 | Contact group |
|
int - group identifier, can be obtained by method contact.getGroupList |
| 4016 | Contact template |
|
int - template number, general in response to method contact.getList with target = template |