Sign in

v1

latestOpenAPI 3.0.12026-08-0621301.7 MB
Goals

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.

get/goals/find

Query parameters

type.name'deals_won' | 'deals_progressed' | 'activities_completed' | 'activities_added' | 'deals_started'

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

titlestring

The title of the goal

is_activeboolean

Whether the goal is active or not

assignee.idinteger

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

assignee.type'person' | 'company' | 'team'

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

expected_outcome.targetnumber

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

expected_outcome.tracking_metric'quantity' | 'sum'

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

expected_outcome.currency_idinteger

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_idinteger[]

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

type.params.stage_idinteger

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_idinteger[]

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.startstring date

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.endstring date

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

Response

Successful response containing payload in the data.goal object

successboolean

If the request was successful or not