Skip to main content
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

Listing people by name 
GET /v1/people?filter[fullName][eq]=John Doe
Listing people by email domain or with empty emails 
GET /v1/people?filter[emails][like]=@folk.app&filter[emails][empty]&combinator=or
Listing people not in any group 
GET /v1/people?filter[groups][empty]
Listing people in some group 
GET /v1/people?filter[groups][in][id]=grp_79b6ed73-9939-4118-ba65-7f8cdf401052
Listing people in a company 
GET /v1/people?filter[companies][in][id]=com_f3855422-6740-4e6a-aa5e-449ac77047d0
Listing people assigned to some users 
GET /v1/people?filter[customFieldValues.grp_79b6ed73-9939-4118-ba65-7f8cdf401052.Owner][in][email]=john@folk.app&filter[customFieldValues.grp_79b6ed73-9939-4118-ba65-7f8cdf401052.Owner][in][email]=alice@folk.app
Listing people associated to some contacts 
GET /v1/people?filter[customFieldValues.grp_79b6ed73-9939-4118-ba65-7f8cdf401052.Relationships][in][id]=per_b6b9edb9-166d-4bdf-a0bf-8d7dac1de98a&filter[customFieldValues.grp_79b6ed73-9939-4118-ba65-7f8cdf401052.Relationships][in][id]=com_ee7c7212-99ba-4e8d-bd14-9ff369c87a1c
Listing companies by name 
GET /v1/companies?filter[name][eq]=ECMA
Listing companies not in any group 
GET /v1/companies?filter[groups][empty]
Listing deals by name 
GET /v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Deals?filter[name][eq]=Project Alpha
Listing deals with the status “Qualified” 
GET /v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Deals?filter[customFieldValues.Status][in]=Qualified

​
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:
OperatorMeaningApplicable to
eqfield is equal to the valueText, numbers, and dates fields
not_eqfield is not equal to the valueText, numbers, and dates fields
gtfield is greater than the valueNumbers and dates fields
ltfield is less than the valueNumbers and dates fields
likefield matches the valueText
not_likefield does not match the valueText
infield is in the list of valuesReference fields
not_infield is not in the list of valuesReference fields
emptyfield is emptyAll fields
not_emptyfield is not emptyAll fields

​
Filterable fields

​
Filterable fields for people

FieldUsageSupported operators
fullName?filter[fullName][like]=Johneq, not_eq, like, not_like, empty, not_empty
firstName?filter[firstName][eq]=Johneq, not_eq, like, not_like,empty, not_empty
lastName?filter[lastName][not_eq]=Doeeq, not_eq, like, not_like,empty, not_empty
jobTitle?filter[jobTitle][like]=Developereq, not_eq, like, not_like,empty, not_empty
birthday?filter[birthday][gt]=1990-01-01eq, not_eq, gt, lt, empty, not_empty
description?filter[description][like]=team playereq, not_eq, like, not_like,empty, not_empty
emails?filter[emails][like]=@folk.appeq, not_eq, like, not_like,empty, not_empty
phones?filter[phones][eq]=+1234567890eq, not_eq, like, not_like,empty, not_empty
addresses?filter[addresses][not_like]=Pariseq, not_eq, like, not_like,empty, not_empty
urls?filter[urls][not_eq]=https://example.comeq, not_eq, like, not_like,empty, not_empty
companies?filter[companies][in][id]=com_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
groups?filter[groups][in][id]=grp_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
createdAt (day precision)?filter[createdAt][gt]=2020-01-01eq, not_eq, gt, lt, empty, not_empty
createdBy?filter[createdBy][in][email]=john@folk.app&filter[createdBy][in][id]=usr_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
customFieldValues.{groupId}.Text?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Text][like]=team playereq, not_eq, like, not_like,empty, not_empty
customFieldValues.{groupId}.Date?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Date][gt]=2020-01-01eq, not_eq, gt, lt, empty, not_empty
customFieldValues.{groupId}.Number?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Number][lt]=200eq, not_eq, gt, lt, empty, not_empty
customFieldValues.{groupId}.Status?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Status][in]=In Progressin, 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]=B2Cin, not_in, empty, not_empty
customFieldValues.{groupId}.Relationships?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Relationships][in][id]=per_a858d1bd-19d3-486d-87a4-c3b13d5b9a99in, 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-f19cff553a22in, not_in, empty, not_empty
customFieldValues.{groupId}.Deals?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Deals][in][id]=obj_5ef2bef1-5234-4e09-bc15-f830697604b8in, not_in, empty, not_empty

​
Filterable fields for companies

FieldUsageSupported operators
name?filter[name][like]=ECMAeq, not_eq, like, not_like,empty, not_empty
description?filter[description][like]=prospecteq, not_eq, like, not_like,empty, not_empty
emails?filter[emails][like]=@folk.appeq, not_eq, like, not_like,empty, not_empty
phones?filter[phones][eq]=+1234567890eq, not_eq, like, not_like,empty, not_empty
addresses?filter[addresses][not_like]=Pariseq, not_eq, like, not_like,empty, not_empty
urls?filter[urls][not_eq]=https://example.comeq, not_eq, like, not_like,empty, not_empty
groups?filter[groups][in][id]=grp_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
createdAt (day precision)?filter[createdAt][gt]=2020-01-01eq, not_eq, gt, lt, empty, not_empty
createdBy?filter[createdBy][in][email]=john@folk.app&filter[createdBy][in][id]=usr_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
customFieldValues.{groupId}.Text?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Text][like]=team playereq, not_eq, like, not_like,empty, not_empty
customFieldValues.{groupId}.Date?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Date][gt]=2020-01-01eq, not_eq, gt, lt, empty, not_empty
customFieldValues.{groupId}.Number?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Number][lt]=200eq, not_eq, gt, lt, empty, not_empty
customFieldValues.{groupId}.Status?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Status][in]=In Progressin, 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]=B2Cin, not_in, empty, not_empty
customFieldValues.{groupId}.Relationships?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Relationships][in][id]=per_a858d1bd-19d3-486d-87a4-c3b13d5b9a99in, 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-f19cff553a22in, not_in, empty, not_empty
customFieldValues.{groupId}.Deals?filter[customFieldValues.grp_c5993dec-0375-407e-9e0a-a310d39f65bd.Deals][in][id]=obj_5ef2bef1-5234-4e09-bc15-f830697604b8in, not_in, empty, not_empty

​
Filterable fields for deals

FieldUsageSupported operators
name?filter[name][like]=Project Alphaeq, not_eq, like, not_like,empty, not_empty
people?filter[people][in][id]=per_a858d1bd-19d3-486d-87a4-c3b13d5b9a99in, not_in, empty, not_empty
companies?filter[companies][in][id]=com_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
createdAt (day precision)?filter[createdAt][gt]=2020-01-01eq, not_eq, gt, lt, empty, not_empty
createdBy?filter[createdBy][in][email]=john@folk.app&filter[createdBy][in][id]=usr_c5993dec-0375-407e-9e0a-a310d39f65bdin, not_in, empty, not_empty
customFieldValues.Text?filter[customFieldValues.Text][like]=team playereq, not_eq, like, not_like,empty, not_empty
customFieldValues.Date?filter[customFieldValues.Date][gt]=2020-01-01eq, not_eq, gt, lt, empty, not_empty
customFieldValues.Number?filter[customFieldValues.Number][lt]=200eq, not_eq, gt, lt, empty, not_empty
customFieldValues.Status?filter[customFieldValues.Status][in]=In Progressin, not_in, empty, not_empty
customFieldValues.Tags?filter[customFieldValues.Tags][in]=B2B&filter[customFieldValues.Tags][in]=B2Cin, not_in, empty, not_empty
customFieldValues.Assign?filter[customFieldValues.Assign][in][email]=john@folk.app&filter[customFieldValues.Assign][in][id]=usr_d24b4748-8a5f-4a46-89fe-f19cff553a22in, not_in, empty, not_empty