Examples
People search
Listing people by nameCompanies search
Listing companies by nameObjects search
Objects of every type are filtered the same way. The examples below list deals, whose object type isDeals.
Listing deals by name
Tasks search
Listing tasks due after a given dateFilter 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:Dates
Date fields of people, companies and objects accept a date in theYYYY-MM-DD format or a date relative to the day of the request:
Where
<n> is a number from 0 to 99 and <unit> is one of day, days, week, weeks, month, months, year or years.
Native date fields such as createdAt or birthday only accept past relative dates, today and yesterday: tomorrow and in-<n>-<unit> are only accepted on date custom fields. An invalid date returns a 422 error.
The foundationYear field of companies holds a year: filter it with a year in the YYYY format, such as ?filter[foundationYear][eq]=1999, which matches the whole year. A YYYY-MM-DD date is also accepted, but only January 1 matches a year with eq and not_eq.
Filters of views
The filter of a view uses the same field keys, operators and value formats as the searches, written in a JSON body rather than in the query string:- the conditions are a list, so the same field can appear in several conditions;
eqandnot_eqon select, user and reference fields take a list and mean “exactly this set of values”.
Filterable fields
References are matched exactly: ids, workspace members by email, and select options by label. Emails and labels are case-sensitive, and an email must belong to an active member of the workspace. A reference that matches nothing is treated as a value no record holds:in and all return no records for it, and not_in returns every record. A workspace member is referenced by id or email: any other key returns a 422.
Filterable fields for people
People can also be filtered on the fields of their primary company, with the
company. prefix. These fields support the same operators as on companies:
Group-scoped fields
A person has oneaddedToGroupAt, one addedToGroupBy and one strongestConnection per group they belong to. A filter on these fields matches a person when it holds in at least one of these groups:
- the groups listed by a
groupsfilter with theinoralloperator, when the filters are combined withand(the default) - every group you can access otherwise: without a
groupsfilter, with only anot_inone, or withcombinator=or
addedToGroupBy and strongestConnection take workspace members, by id or email, like createdBy.
Listing people added to a group during the last 30 days
Filterable fields for companies
Filterable fields for objects
These fields apply to objects of every type, such as deals. Custom fields are named without a group ID, since an object belongs to a single group.Unlike people and companies, objects cannot be filtered on relationship
(
contactField) custom fields, and object types have no object
(objectField) custom fields. To find the objects linked to a person or a company,
filter on people or companies. To find the people or companies linked to
an object, filter people or companies on the object type field, such as
customFieldValues.{groupId}.Deals above.Filterable fields for tasks
dueAt and createdAt take a date in the YYYY-MM-DD format, without relative dates. gt and lt on completedAt take one ISO 8601 datetime, such as 2025-01-01T00:00:00Z: a YYYY-MM-DD date returns a 422.