v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBList Goals
Returns goals for an employee. Use this endpoint to locate goals by title before updating, commenting on, closing, reopening, or deleting them. Use filter=status-inProgress when the user asks for current/active goals, filter=status-completed for completed goals, filter=status-closed for closed goals, and filter=status-all when the user says "all goals", "including closed", or you are resolving a goal by title for a write operation where the status is unknown. If no filter is provided, closed goals are excluded. Results are capped at 50 goals; if a title lookup is ambiguous or absent, do not update or delete a different goal.
OAuth Scopes: goal
Path parameters
The internal employee ID of the employee the goals are assigned to.
Query parameters
Goal status filter. Use status-inProgress for current active goals, status-completed for completed goals, status-closed for closed goals, and status-all when locating a goal by title for update/delete/reopen or when the user asks for all goals. If omitted, closed goals are excluded. Unrecognized values behave like omission.
Response
The response content will be a JSON document with the requested information.
Example response
{
"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
}
}
]
}