Get Aggregate Goal Info

Provides goal information, goal comments, and employees shared with goals or who have commented on the given goal.

Sample Request Url

https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/20/aggregate

Sample 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"
    }
}
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!