v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Goals

Public API

Get Goal Aggregate

Returns a single goal with its comments, alignment options, and a list of all persons who are either shared on the goal or have commented on it. Useful for rendering a full goal detail view in a single request.

OAuth Scopes: goal

get/api/v1/performance/employees/{employeeId}/goals/{goalId}/aggregate

Path parameters

employeeIdstring required

The internal employee ID of the employee the goal is associated with.

goalIdstring required

goalId is the Goal ID used to generate the aggregate information.

Response

The response content will be a JSON object with the requested information.

canAlignboolean

The selected user can align goals with other users.

canCreateGoalsboolean

The selected user can create a goal.

Example response

{
  "goal": {
    "id": "4",
    "title": "Complete Documentation Epic",
    "description": "Document every endpoint for the goals API.",
    "percentComplete": 78,
    "dueDate": "2025-12-31",
    "completionDate": "2025-12-17T10:30:00Z",
    "lastChangedDateTime": "2025-12-17T10:30:00Z",
    "status": "in_progress",
    "milestones": [
      {
        "id": 2,
        "employeeGoalId": 12,
        "title": "Sell 15 Doohickeys",
        "completedDateTime": "2025-04-10T15:36:38Z",
        "lastUpdateDateTime": "2025-04-10T15:36:38Z",
        "lastUpdateUserId": 24
      }
    ],
    "actions": {
      "canEditGoalMilestoneProgressBar": true
    }
  },
  "canCreateGoals": true,
  "alignsWithOptions": [
    {
      "id": 8,
      "title": "Get all team goals for January complete."
    }
  ],
  "comments": [
    {
      "id": "2",
      "authorUserId": 1534,
      "createdAt": "2022-05-23T15:52:42Z",
      "text": "This goal is taking longer than I thought."
    }
  ],
  "persons": [
    {
      "employeeId": 4353,
      "userId": 45,
      "displayFirstName": "Tim",
      "lastName": "Johnson",
      "photoUrl": "https://tim.johnson.jpg"
    }
  ]
}