Get All Aggregate Goal Info

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.

Sample Request Url

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

Sample Response

{
    "canAlign": false,
    "canCreateGoals": true,
    "filters": [
        {
            "id": "status-inProgress",
            "name": "In Progress",
            "count": 2
        },
        {
            "id": "status-completed",
            "name": "Completed",
            "count": 1
        }
    ],
    "selectedFilter": "status-inProgress",
    "goals": [
        {
            "id": "1",
            "title": "Lorem ipsum dolor sit amet",
            "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat",
            "percentComplete": 60,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                23
            ],
            "dueDate": "2021-12-17",
            "completionDate": null,
            "status": "in_progress"
        },
        {
            "id": "2",
            "title": "Duis aute irure",
            "description": null,
            "percentComplete": 70,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                23,
                24
            ],
            "dueDate": "2022-05-31",
            "completionDate": null,
            "status": "in_progress"
        }
    ],
    "persons": [
        {
            "employeeId": 23,
            "userId": null,
            "displayFirstName": "Poe",
            "lastName": "Panda",
            "photoUrl": "https://poePandaImage.jpg"
        },
        {
            "employeeId": 24,
            "userId": null,
            "displayFirstName": "Jim",
            "lastName": "Panda",
            "photoUrl": "https://jimPandaImage.jpg"
        }
    ],
    "comments": [
        {
            "goalId": "1",
            "commentCount": 1
        },
        {
            "goalId": "2",
            "commentCount": 0
        }
    ]
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!