PIpipedrive
Filters

Add a new filter

Changed on

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 <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter</a>.

post/filters

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: deals:full, activities:full, contacts:full

Query parameters

include_field_codeboolean

If set to true, each condition in the response includes a field_code field identifying the field by its code name

Request body

namestring required

The name of the filter

conditionsobject 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'deals' | 'leads' | 'org' | 'people' | 'products' | 'activity' | 'projects' required

The type of filter to create

Response

Success

successboolean

If the response is successful or not

Changes

  • b57708cb0b44Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the // response's property type changed from integer to no type for status

    • info

      added the new optional query request parameter include_field_code

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #1 to the // response property allOf list for the response status

  • ffe4619b621aRevision changes
    • warning

      added the new projects enum value to the // response property for the response status

    • info

      added the new projects enum value to the request property /