v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Goals

Public API

Get Goals Aggregate (v1)

Deprecated. Use "Get Goals Aggregate (v1.1)" instead. Provides a list of all goals, type counts, goal comment counts, and employees shared with goals for the given employee. This version of the endpoint will not return any goals with milestones. Milestone functionality for this endpoint begins in version 1.2.

OAuth Scopes: goal

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

Path parameters

employeeIdstring required

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

Query parameters

filterstring

Filter goals by status. Accepts filter IDs returned by the filters endpoint (e.g. status-inProgress). If omitted or invalid, defaults to the first available filter. The API accepts arbitrary strings and returns 200.

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

{
  "canCreateGoals": true,
  "filters": {
    "filters": [
      {
        "id": "status-inProgress",
        "name": "In Progress",
        "count": 1
      }
    ]
  },
  "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
    }
  ]
}