provider Goals GET /goals/find
@utdk/pipedrive /goals/find
Find goals
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.
type.name query
The type of the goal. If provided, everyone's goals will be returned.
enum: deals_won, deals_progressed, activities_completed, activities_added…
title query
The title of the goal
string
is_active query
Whether the goal is active or not
boolean
assignee.id query
The ID of the user who's goal to fetch. When omitted, only your goals will be returned.
integer
assignee.type query
The type of the goal's assignee. If provided, everyone's goals will be returned.
enum: person, company, team
expected_outcome.target query
The numeric value of the outcome. If provided, everyone's goals will be returned.
number
expected_outcome.tracking_metric query
The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
enum: quantity, sum
expected_outcome.currency_id query
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.
integer
type.params.pipeline_id query
An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned.
array
type.params.stage_id query
The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
integer
type.params.activity_type_id query
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.
array
period.start query
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.
string
period.end query
The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
string

Try it

Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getgoals
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.

The type of the goal. If provided, everyone's goals will be returned.

The title of the goal

Whether the goal is active or not

The ID of the user who's goal to fetch. When omitted, only your goals will be returned.

The type of the goal's assignee. If provided, everyone's goals will be returned.

The numeric value of the outcome. If provided, everyone's goals will be returned.

The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.

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.

An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned.

The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.

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.

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.

The end date of the period for which to find goals. Date in format of YYYY-MM-DD.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.getgoals({
  "is_active": true
})