Filters

Returns data about a specific filter. Note that this also returns the condition lines of the filter.

get/filters/{id}

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:read, deals:full, activities:read, activities:full, contacts:read, contacts:full

Path parameters

idinteger required

The ID of the filter

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

Response

Success

successboolean

If the response is successful or not

Changes

    • 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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

      added the new projects enum value to the // response property for the response 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