Retrieve goals in team

This endpoint allows you to retrieve information about goals within the specified team. This information enables you to access data that can be automated later.

‍Request

• Method: GET
• Path: /external/v0/zapier/webhooks/teams/{teamId}/goals
• Header:

• X-KEY: API key for authentication.

Response

After successfully retrieving GTD objects, you will receive response in JSON format with the following information:

[

     {

        "name": "testing goal metric",

        "description": "This is metric testing goal.",

        "startDate": null,

        "endDate": null,

        "sortOrder": 363.0,

        "parentGoalId": 7850,

        "goalType": "METRIC",

        "id": 7901,

        "state": "OPEN",

        "statusId": 0,

        "statusName": null,

        "teamId": 20500,

        "teamName": "Zapier_02",

        "ownerId": 13450,

        "ownerName": "Black Jane",

        "createdAt": "2023-09-18T12:10:19.444Z",

        "assignee": [

            {

                "id": 13450454,

                "fullName": "Blue Angelina"

            }

        ],

        "tenant": 409,

        "metric": {

            "metricUnit": "kg",

            "decimals": 2,

            "goalValue": 100.00000,

            "value": 0.00000,

            "id": 6500,

            "goalId": 7901,

            "synchronizedValue": false,

            "dataSource": null,

            "hubspotDataType": null,

            "syncDataKey": null,

            "lastSyncAt": null,

            "status": null

        },

        "deleted": false,

        "calcNumOpenSubGoals": 0

    },

    ...

] 

Description of attributes:

• id: Unique identifier of the goal in the system.
• name: Field containing the name of the goal. It is a string that describes what the goal is about.
• description: Contains the description of the goal. It is a string that can provide more detailed information about what the goal involves.
• startDate: Contains the start date of the goal. If the value is null, it means the goal does not have a specified start date.
• endDate: This field contains the end date of the goal. If the value is null, it indicates that the goal does not have a specified end date.
• sortOrder: A number that determines the order of the goal in the list of goals or hierarchical tree of goals.
• parentGoalId: Identifier of the parent goal if the goal is part of a goal hierarchy. If it is not part of a hierarchy, it has a null value.
• goalType: Defines the type of goal. It can take on the values "ACTIVITY" and "METRIC."
• state: Defines the state of the goal. The state can be "OPEN" or "CLOSED," depending on whether the goal is active or closed.
• statusId: Contains the identifier of the goal's status.
• statusName: Contains the name of the goal's status.
• teamId: Identifier of the team or group to which the goal belongs.
• ownerId: Field containing the identifier of the goal's owner.
• createdAt: This field contains the date and time of goal creation.
• assignee: This field may contain information about assigned individuals who are responsible for achieving the goal.
• tenant: This field contains the identifier of the tenant or organization associated with the goal.
• metric: This field contains the metric used to measure the goal.

• metricUnit: Units of the metric.
• decimals: Number of decimal places for the metric.
• goalValue: Target value of the metric.
• value: Current value of the metric.
• id: Unique identifier of the metric.
• goalId: Identifier of the goal to which this metric belongs.
• synchronizedValue: Information about whether the metric value is synchronized (false indicates it is not synchronized).
• dataSource: External data source for the metric.
• hubspotDataType: Data type of the metric in the HubSpot system.
• syncDataKey: Key for data synchronization of the metric.
• lastSyncAt: Date and time of the last synchronization of metric data.
• status: Metric status.

• deleted: Identifier of whether the goal is marked as deleted (true) or not (false).
• calcNumOpenSubGoals: This number indicates the count of open sub-goals that are part of this goal.

‍

‍