Goals

OverviewEndpoints

In HubSpot, goals are used to create user-specific quotas for their sales and services teams based on templates provided by HubSpot. The goals API allow you to retrieve goals data in your HubSpot account. 

Learn more about using goals in HubSpot.

Please note: from the list of endponts listed in the Endpoints tab, only the endpoints listed below are currently available and supported:

  • GET all goals
  • GET a specific goal
  • POST search request to request a goal with filters
  • GET associations of a specific goal
  • GET goals in batches

Goals cannot be edited or deleted through the API.

Retrieve goals

You can retrieve an individual goal or all goals in your account.

  • To request a list of all goals, make a GET request to /crm/v3/objects/goal_targets.
  • To retrieve an individual goal, make a GET request to /crm/v4/objects/goal_targets/{goalTargetId}/.

For example, to retrieve a goal with an ID of 44027423340, then the request URL would be the following:

https://api.hubapi.com/crm/v4/objects/goal_targets/44027423340/

Goals properties

When making a GET request to the Goals API, you can also request specific goal properties:

  • hs_goal_name: This is a string that denotes the name of a goal.
  • hs_target_amount: Number that denotes the goal target value.
  • hs_start_datetime: Goal's start date as a UTC timestamp.
  • hs_end_datetime: Goal's end date as a UTC timestamp.
  • hs_created_by_user_id: HubSpot UserId of the person who created the goal, not the one assigned to a goal.

For example, if you wanted to include all properties listed above, the request URL may resemble the following:

https://api.hubapi.com/crm/v4/objects/goal_targets/44027423340?properties=hs_goal_name,hs_target_amount,hs_start_datetime,hs_end_datetime,hs_created_by_user_id

The response may look similar to the JSON excerpt below:

// Example response for GET request to /crm/v4/objects/goal_targets/{goal_target_id}/ { "id": '44027423340', "properties": { "hs_created_by_user_id": '885536', "hs_createdate": '2023-02-15T15:53:07.080Z', "hs_end_datetime": '2024-01-01T00:00:00Z', "hs_goal_name": 'Revenue Goal 2023', "hs_lastmodifieddate": '2023-02-16T10:02:21.131Z', "hs_object_id": '44027423340', "hs_start_datetime": '2023-12-01T00:00:00Z', "hs_target_amount": '2000.00' }, "createdAt": '2023-02-15T15:53:07.080Z', "updatedAt": '2023-02-16T10:02:21.131Z', "archived": false }
Was this article helpful?
This form is used for documentation feedback only. Learn how to get help with HubSpot.