Filters

Many entities can be filtered when hitting the list endpoint (i.e. /contacts). The filter comes in the form of a query parameter such as /contacts?filter[{type}][]={value}. These filters power the list pages for each of the three core entities.

Core Entity (Accounts, Contacts, Leads) Filters

These filters types are available for all core entities:

Data Filters

These filters are for data directly related to a given entity:

createdTime, lastContactedTime, phone, email, name, nextActivityStartTime, address, number (meaning lead number)

📘

Addresses

Filtering based on address can be done by specifying an address subfield to filter on, such as filter[address][country]=US.

📘

Numeric ranges

You can specify ranges for numeric searches using < and >. For example: filter[number]=>1020

📘

Timespans

To filter based on a time range, you must provide two timestamps. For example, to find all entities created between March 1st, 2025, and March 15th, 2025, you would use filter[createdTime]=2025-03-01T00:00:00%20TO%202025-03-15T23:59:59

ID Filters

These filters represent relations between a core entity and some other entity within Nutshell. For example, using filter[contacts]=1will return only entities somehow related to the contact with ID 1.

'accounts', 'contacts', 'creator', 'id', 'omittedId', 'markets', 'origin', 'owners', 'primaryAccountOwner', 'products', 'competitors', 'sources', 'channels', 'tags', 'accountTags', 'contactTags', 'contactIds', 'accountIds', 'leadIds', 'territories', 'milestones', 'outcomes', 'accountTypes', 'industries', 'watchers', 'stageset', 'receivedEmailSequenceTemplates', 'inProgressEmailSequenceTemplates', 'receivedReplyEmailSequenceTemplates', 'noReplyEmailSequenceTemplates', 'openedEmailSequenceTemplates', 'clickedEmailSequenceTemplates', 'audiences', 'subscribedAudiences', 'unsubscribedAudiences', 'sentEditions', 'receivedEditions', 'viewedEditions', 'clickedEditions', 'bouncedEditions', 'unsubscribedEditions', 'sentDripSequences', 'receivedDripSequences', 'viewedDripSequences', 'clickedDripSequences', 'bouncedDripSequences', 'inProgressDripSequences', 'receivedAllMessagesDripSequences', 'unsubscribedDripSequences', 'forms', 'childAccounts', 'parentAccount'

Custom Field Filters

You can also filter by custom fields where the filter type is the name of the custom field.

Account (Company) Filters

These filters only apply to Accounts:

'numberOfLeads', 'numberOfContacts', 'valueOfOpenLeads', valueOfWonLeads', 'valueOfLostLeads', 'valueOfCancelledLeads', 'numberOfOpenLeads', 'numberOfWonLeads', 'numberOfLostLeads', 'numberOfCancelledLeads', 'numChildAccounts', 'parentAccount', 'childAccounts', 'revenue', 'numberOfEmployees'

Contact (Person) Filters

These filters only apply to Contacts:

'jobTitle', 'numberOfLeads', 'audiences', 'subscribedAudiences', 'unsubscribedAudiences', 'unsubscribedFromAllEmails', 'sentEditions', 'receivedEditions', 'viewedEditions', 'clickedEditions', 'bouncedEditions', 'sentDripSequences', 'receivedDripSequences', 'viewedDripSequences', 'clickedDripSequences', 'inProgressDripSequences', 'receivedAllMessagesDripSequences', 'bouncedDripSequences', 'marketingLastContactedTime', 'valueOfOpenLeads', valueOfWonLeads', 'valueOfLostLeads', 'valueOfCancelledLeads', 'numberOfOpenLeads', 'numberOfWonLeads', 'numberOfLostLeads', 'numberOfCancelledLeads'

Lead Filters

These filters only apply to Leads:

'status', 'watchers', 'closedTime', 'confidence', 'numberOfActivities', 'numberOfEmails', 'isOverdue', 'overdueDuration', 'priority', 'activityStartTime', 'activityEndTime', 'activityParticipants', 'numberLoggedActivities', 'parentAccount'