get
https://{companyDomain}.bamboohr.com/api/v1/performance/employees//goals//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
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Sample Request Url
https://{companyDomain}.bamboohr.com/api/v1/performance/employees/123/goals/20/aggregateSample Response With Milestones
{
"goal": {
"id": "20",
"title": "Lorem ipsum",
"description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
"percentComplete": 100,
"alignsWithOptionId": null,
"sharedWithEmployeeIds": [
123
],
"dueDate": "2021-03-17",
"completionDate": "2022-05-26T20:07:45Z",
"status": "completed",
"milestones": [
{
"id": 17,
"employeeGoalId": 16,
"title": "Lorem ipsum dolor sit amet",
"currentValue": 100,
"startValue": 100,
"endValue": 50,
"completedDateTime": null,
"lastUpdateDateTime": "2022-07-15T15:37:02Z",
"lastUpdateUserId": 123
}
],
"actions": {
"canEditGoalProgressBar": false,
"canEditGoalMilestoneProgressBar": true
}
},
"canAlign": false,
"canCreateGoals": true,
"alignsWithOptions": [],
"comments": [],
"persons": [
{
"employeeId": 123,
"userId": null,
"displayFirstName": "Poe",
"lastName": "Panda",
"photoUrl": "https://poePandaImage.json"
}
]
}Sample Response WIthout Milestones
{
"goal": {
"id": "20",
"title": "Lorem ipsum",
"description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
"percentComplete": 100,
"alignsWithOptionId": null,
"sharedWithEmployeeIds": [
123
],
"dueDate": "2021-03-17",
"completionDate": "2022-05-26T20:07:45Z",
"status": "completed"
}
}The authenticated caller does not have permission to view this goal.
The specified goalId was not found.