Introducton
Filtering
Some top level API resources can be filtered when listing them. Using filtering is a faster alternative to paginating through all resources. To create a search query, review the filter syntax and reference the filterable fields of the resource.
Examples
People search
Listing people by name
Listing people by email domain or with empty emails
Listing people not in any group
Listing people in some group
Listing people in a company
Listing people assigned to some users
Listing people associated to some contacts
Companies search
Listing companies by name
Listing companies not in any group
Filter syntax
The filter syntax allows you to specify conditions for the fields you want to filter by. The syntax is as follows:
?filter[<field>][<operator>]=<value>
Where:
<field>is the field we want to filter on<operator>is the operation we want to perform<value>is the value we’re filtering against
Operators
The following operators are available for filtering:
| Operator | Meaning | Applicable to |
|---|---|---|
eq | field is equal to the value | Text, numbers, and dates fields |
not_eq | field is not equal to the value | Text, numbers, and dates fields |
gt | field is greater than the value | Numbers and dates fields |
lt | field is less than the value | Numbers and dates fields |
like | field matches the value | Text |
not_like | field does not match the value | Text |
in | field is in the list of values | Reference fields |
not_in | field is not in the list of values | Reference fields |
empty | field is empty | All fields |
not_empty | field is not empty | All fields |
Filterable fields
Filterable fields for people
| Field | Usage | Supported operators |
|---|---|---|
fullName | ?filter[fullName][like]=John | eq, not_eq, like, not_like,empty, not_empty |
firstName | ?filter[firstName][eq]=John | eq, not_eq, like, not_like,empty, not_empty |
lastName | ?filter[lastName][not_eq]=Doe | eq, not_eq, like, not_like,empty, not_empty |
jobTitle | ?filter[jobTitle][like]=Developer | eq, not_eq, like, not_like,empty, not_empty |
birthday | ?filter[birthday][gt]=1990-01-01 | eq, not_eq, gt, lt, empty, not_empty |
description | ?filter[description][like]=team player | eq, not_eq, like, not_like,empty, not_empty |
emails | ?filter[emails][like]=@folk.app | eq, not_eq, gt, lt, empty, not_empty |
phones | ?filter[phones][eq]=+1234567890 | eq, not_eq, gt, lt, empty, not_empty |
addresses | ?filter[addresses][not_like]=Paris | eq, not_eq, gt, lt, empty, not_empty |
urls | ?filter[urls][not_eq]=https://example.com | eq, not_eq, gt, lt, empty, not_empty |
companies | ?filter[companies][in][id]=com_c5993dec-0375-407e-9e0a-a310d39f65bd | in, not_in, empty, not_empty |
groups | ?filter[groups][in][id]=grp_c5993dec-0375-407e-9e0a-a310d39f65bd | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Text | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Text][like]=team player | eq, not_eq, like, not_like,empty, not_empty |
customFieldValues.{groupId}.Date | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Date][gt]=2020-01-01 | eq, not_eq, gt, lt, empty, not_empty |
customFieldValues.{groupId}.Number | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Number][lt]=200 | eq, not_eq, gt, lt, empty, not_empty |
customFieldValues.{groupId}.Status | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Status][in]=In Progress | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Tags | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Tags][in]=B2B&filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Tags][in]=B2C | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Relationships | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Relationships][in][id]=per_a858d1bd-19d3-486d-87a4-c3b13d5b9a99 | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Assign | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Assign][in][email]=john@folk.app&filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Assign][in][id]=usr_d24b4748-8a5f-4a46-89fe-f19cff553a22 | in, not_in, empty, not_empty |
Filterable fields for companies
| Field | Usage | Supported operators |
|---|---|---|
name | ?filter[name][like]=ECMA | eq, not_eq, like, not_like,empty, not_empty |
description | ?filter[description][like]=prospect | eq, not_eq, like, not_like,empty, not_empty |
emails | ?filter[emails][like]=@folk.app | eq, not_eq, gt, lt, empty, not_empty |
phones | ?filter[phones][eq]=+1234567890 | eq, not_eq, gt, lt, empty, not_empty |
addresses | ?filter[addresses][not_like]=Paris | eq, not_eq, gt, lt, empty, not_empty |
urls | ?filter[urls][not_eq]=https://example.com | eq, not_eq, gt, lt, empty, not_empty |
groups | ?filter[groups][in][id]=grp_c5993dec-0375-407e-9e0a-a310d39f65bd | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Text | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Text][like]=team player | eq, not_eq, like, not_like,empty, not_empty |
customFieldValues.{groupId}.Date | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Date][gt]=2020-01-01 | eq, not_eq, gt, lt, empty, not_empty |
customFieldValues.{groupId}.Number | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Number][lt]=200 | eq, not_eq, gt, lt, empty, not_empty |
customFieldValues.{groupId}.Status | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Status][in]=In Progress | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Tags | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Tags][in]=B2B&filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Tags][in]=B2C | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Relationships | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Relationships][in][id]=per_a858d1bd-19d3-486d-87a4-c3b13d5b9a99 | in, not_in, empty, not_empty |
customFieldValues.{groupId}.Assign | ?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Assign][in][email]=john@folk.app&filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Assign][in][id]=usr_d24b4748-8a5f-4a46-89fe-f19cff553a22 | in, not_in, empty, not_empty |