v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Goals

Public API

Get Goals Aggregate (v1.2)

Provides a goals dashboard for an employee: goals matching the selected filter, status filter counts/actions, comment counts, and people shared with or commenting on those goals. This v1.2 endpoint includes milestone-based goals in the returned goal list. Use the optional filter query parameter to control which statuses are included; use status-all when the user asks for a complete dashboard across active, completed, and closed goals. Note: Compared to "Get Goals Aggregate (v1.1)", this version returns goals that contain milestones.

OAuth Scopes: goal

get/api/v1_2/performance/employees/{employeeId}/goals/aggregate

Path parameters

employeeIdstring required

The internal employee ID of the employee whose goals are aggregated.

Query parameters

filterstring

Optional status filter for the goals collection in the aggregate response. Use status-all for a full dashboard across statuses; otherwise pass status-inProgress, status-completed, or status-closed. If omitted or invalid, defaults to the first available filter. The response's filters counts may include statuses beyond the selected goal list.

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.

selectedFilterstring

The id of the current selected filter.

Example response

{
  "canAlign": true,
  "canCreateGoals": true,
  "filters": {
    "filters": [
      {
        "id": "status-inProgress",
        "name": "In Progress",
        "count": 1,
        "actions": {
          "canCloseGoal": true,
          "canEditGoal": true,
          "canEditGoalProgressBar": true,
          "canShareGoal": true
        }
      }
    ]
  },
  "selectedFilter": "status-inProgress",
  "goals": [
    {
      "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
      }
    }
  ],
  "persons": [
    {
      "employeeId": 4353,
      "userId": 45,
      "displayFirstName": "Tim",
      "lastName": "Johnson",
      "photoUrl": "https://tim.johnson.jpg"
    }
  ],
  "comments": [
    {
      "goalId": "25",
      "commentCount": 2
    }
  ]
}