Back to Pipedrive OauthFind 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.
Input
type: object
properties:
parameters:
type: object
properties:
type.name:
type: string
enum:
- deals_won
- deals_progressed
- activities_completed
- activities_added
- deals_started
description: The type of the goal. If provided, everyone's goals will be returned.
title:
type: string
description: The title of the goal
is_active:
type: boolean
enum:
- true
- false
default: true
description: Whether the goal is active or not
assignee.id:
type: integer
description: >-
The ID of the user who's goal to fetch. When omitted, only your goals
will be returned.
assignee.type:
type: string
enum:
- person
- company
- team
description: >-
The type of the goal's assignee. If provided, everyone's goals will be
returned.
expected_outcome.target:
type: number
description: >-
The numeric value of the outcome. If provided, everyone's goals will
be returned.
expected_outcome.tracking_metric:
type: string
enum:
- quantity
- sum
description: >-
The tracking metric of the expected outcome of the goal. If provided,
everyone's goals will be returned.
expected_outcome.currency_id:
type: integer
description: >-
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.params.pipeline_id:
type: array
items:
type: integer
description: >-
An array of pipeline IDs or `null` for all pipelines. If provided,
everyone's goals will be returned.
type.params.stage_id:
type: integer
description: >-
The ID of the stage. Applicable to only `deals_progressed` type of
goals. If provided, everyone's goals will be returned.
type.params.activity_type_id:
type: array
items:
type: integer
description: >-
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.
period.start:
type: string
format: date
description: >-
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.
period.end:
type: string
format: date
description: >-
The end date of the period for which to find goals. Date in format of
YYYY-MM-DD.
Output
title: getGoalsResponse200
type: object
properties:
success:
type: boolean
description: If the request was successful or not
data:
type: object
properties:
goals:
type: array
items:
type: object
properties:
id:
type: string
description: The ID of the goal
owner_id:
type: integer
description: The ID of the creator of the goal
title:
type: string
description: The title of the goal
type:
type: object
description: The type of the goal
properties:
name:
type: string
description: The name of the goal type
params:
type: object
description: The parameters that accompany the goal type
properties:
pipeline_id:
type: array
description: The IDs of pipelines of the goal
items:
type: integer
activity_type_id:
type: array
description: The IDs of activity types of the goal
items:
type: integer
assignee:
type: object
description: Who the goal is assigned to
properties:
id:
type: integer
description: The ID of the goal assignee
type:
type: string
description: The type of the assignee
interval:
type: string
description: The interval of the goal
duration:
type: object
description: The duration of the goal
properties:
start:
type: string
description: The start date of the goal
end:
type: string
description: The end date of the goal
expected_outcome:
type: object
description: The expected outcome of the goal
properties:
target:
type: integer
description: The numeric target of the goal
tracking_metric:
type: string
description: The tracking metric of the goal
is_active:
type: boolean
description: Whether the goal is currently active or not
report_ids:
type: array
description: The IDs of the reports that belong to the goal
items:
type: string