GET /goals/find

Returns data about goals based on criteria. For searching, append {searchField}={searchValue} to the URL, where searchField can be any one of the lowest-level fields in dot-notation (e.g. type.params.pipeline_id; title). searchValue should be the value you are looking for on that field. Additionally, is_active=<true|false> can be provided to search for only active/inactive goals. When providing period.start, period.end must also be provided and vice versa.

Servers

https://api.pipedrive.com/v1

Query parameters

Name	Type	Required	Description
`expected_outcome.tracking_metric`	String	No	The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned. Possible values: `"quantity"` `"sum"`
`type.params.activity_type_id[]`	Array	No	An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone's goals will be returned.
`is_active`	Boolean	No	Whether the goal is active or not Default value: true
`assignee.type`	String	No	The type of the goal's assignee. If provided, everyone's goals will be returned. Possible values: `"company"` `"team"` `"person"`
`expected_outcome.currency_id`	Integer	No	The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
`type.name`	String	No	The type of the goal. If provided, everyone's goals will be returned. Possible values: `"activities_completed"` `"deals_won"` `"deals_started"` `"deals_progressed"` `"activities_added"`
`expected_outcome.target`	Number	No	The numeric value of the outcome. If provided, everyone's goals will be returned.
`period.end`	String	No	The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
`type.params.pipeline_id[]`	Array	No	An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned.
`title`	String	No	The title of the goal
`type.params.stage_id`	Integer	No	The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
`assignee.id`	Integer	No	The ID of the user who's goal to fetch. When omitted, only your goals will be returned.
`period.start`	String	No	The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.