Get All Aggregate Goal Info, Version 1.1

Provides a list of all goals, type counts, filter actions, goal comment counts, and employees shared with goals for the given employee. Difference from Version 1: Returns goals in the closed filter and provides filter actions for each filter.

Sample Request Url

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

Sample Response

{
    "canAlign": false,
    "canCreateGoals": true,
    "filters": [
        {
            "id": "status-inProgress",
            "name": "In Progress",
            "count": 2,
            "actions": {
                "canCloseGoal": true,
                "canEditGoal": true,
                "canEditGoalProgressBar": true,
                "canRestoreGoal": false,
                "canShareGoal": true
            }
        },
        {
            "id": "status-completed",
            "name": "Completed",
            "count": 1,
            "actions": {
                "canCloseGoal": false,
                "canEditGoal": true,
                "canEditGoalProgressBar": true,
                "canRestoreGoal": false,
                "canShareGoal": true
            }
        },
        {
            "id": "status-closed",
            "name": "Closed",
            "count": 4,
            "actions": {
                "canCloseGoal": false,
                "canEditGoal": false,
                "canEditGoalProgressBar": false,
                "canRestoreGoal": true,
                "canShareGoal": false
            }
        }
    ],
    "selectedFilter": "status-inProgress",
    "goals": [
        {
            "id": "1",
            "title": "Lorem ipsum",
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "percentComplete": 60,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                23
            ],
            "dueDate": "2021-12-17",
            "completionDate": null,
            "status": "in_progress"
        },
        {
            "id": "41",
            "title": "Ut enim ad minim veniam",
            "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": "23",
            "commentCount": 1
        },
        {
            "goalId": "24",
            "commentCount": 0
        }
    ]
}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!