Filters
Each filter is essentially a set of data validation conditions. A filter of the same kind can be applied when fetching a list of deals, leads, persons, organizations or products in the context of a pipeline. Filters are limited to a maximum of 16 conditions. When applied, only items matching the conditions of the filter are returned. Detailed definitions of filter conditions and additional functionality is not yet available.
Get all filters
Returns data about all filters.
Request
/v1/filters
Query parameters
type
string
The types of filters to fetch
Values
deals
leads
org
people
products
activity
projects
Response
OK
Expand all
Copy code- true
- [ ... ]▶
Get all filter helpers
Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to add or update filters. For more information, see the tutorial for adding a filter.
Request
/v1/filters/helpers
Response
OK
Expand allCopy code- true
- { ... }▶
Get one filter
Returns data about a specific filter. Note that this also returns the condition lines of the filter.
Request
/v1/filters/{id}
Path parameters
id
integer
required
The ID of the filter
Response
OK
Expand allCopy code- true
- { ... }▶
Add a new filter
Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for adding a filter.
Request
/v1/filters
Body parameters
application/json
name
string
required
The name of the filter
conditions
object
required
The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter and date values must be supplied in the YYYY-MM-DD format. It requires a minimum structure as follows: {"glue":"and","conditions":[{"glue":"and","conditions": [CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}. Replace CONDITION_OBJECTS with JSON objects of the following structure: {"object":"","field_id":"", "operator":"","value":"", "extra_value":""} or leave the array empty. Depending on the object type you should use another API endpoint to get field_id. There are five types of objects you can choose from: "person", "deal", "organization", "product", "activity" and you can use these types of operators depending on what type of a field you have: "IS NOT NULL", "IS NULL", "<=", ">=", "<", ">", "!=", "=", "LIKE '$%'", "LIKE '%$%'", "NOT LIKE '$%'". To get a better understanding of how filters work try creating them directly from the Pipedrive application.
type
string
required
The type of filter to create
Values
deals
leads
org
people
products
activity
projects
Response
OK
Expand allCopy code- true
- { ... }▶
Update filter
Updates an existing filter.
Request
/v1/filters/{id}
Path parameters
id
integer
required
The ID of the filter
Body parameters
application/json
name
string
The name of the filter
conditions
object
required
The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter and date values must be supplied in the YYYY-MM-DD format. It requires a minimum structure as follows: {"glue":"and","conditions":[{"glue":"and","conditions": [CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}. Replace CONDITION_OBJECTS with JSON objects of the following structure: {"object":"","field_id":"", "operator":"","value":"", "extra_value":""} or leave the array empty. Depending on the object type you should use another API endpoint to get field_id. There are five types of objects you can choose from: "person", "deal", "organization", "product", "activity" and you can use these types of operators depending on what type of a field you have: "IS NOT NULL", "IS NULL", "<=", ">=", "<", ">", "!=", "=", "LIKE '$%'", "LIKE '%$%'", "NOT LIKE '$%'". To get a better understanding of how filters work try creating them directly from the Pipedrive application.
Response
OK
Expand allCopy code- true
- { ... }▶
Delete multiple filters in bulk
Marks multiple filters as deleted.
Request
/v1/filters
Query parameters
ids
string
required
The comma-separated filter IDs to delete
Response
OK
Expand allCopy code- true
- { ... }▶
Delete a filter
Marks a filter as deleted.
Request
/v1/filters/{id}
Path parameters
id
integer
required
The ID of the filter
Response
OK
Expand allCopy code- true
- { ... }▶