Get All Aggregate Goal Info, Version 1.2

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.1: Returns all goals, including goals that contain milestones.

Sample Request URL

https://api.bamboohr.com/api/gateway.php/samplecompany/v1_2/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,
                "canReopenGoal": false,
                "canShareGoal": true
            }
        },
        {
            "id": "status-completed",
            "name": "Completed",
            "count": 1,
            "actions": {
                "canCloseGoal": false,
                "canEditGoal": true,
                "canEditGoalProgressBar": true,
                "canReopenGoal": false,
                "canShareGoal": true
            }
        },
        {
            "id": "status-closed",
            "name": "Closed",
            "count": 1,
            "actions": {
                "canCloseGoal": false,
                "canEditGoal": false,
                "canEditGoalProgressBar": false,
                "canReopenGoal": true,
                "canShareGoal": false
            }
        }
    ],
    "selectedFilter": "status-inProgress",
    "goals": [
        {
            "id": "11",
            "title": "Complete Task Alpha",
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
            "percentComplete": 5,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                123
            ],
            "dueDate": "2024-03-17",
            "completionDate": null,
            "status": "in_progress"
        },
        {
            "id": "16",
            "title": "Improve SPU",
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
            "percentComplete": 25,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                123
            ],
            "dueDate": "2024-03-17",
            "completionDate": null,
            "status": "in_progress",
            "milestones": [
                {
                    "id": 17,
                    "employeeGoalId": 16,
                    "title": "Get price down from 100 to 50",
                    "currentValue": 75,
                    "startValue": 100,
                    "endValue": 50,
                    "completedDateTime": null,
                    "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                    "lastUpdateUserId": 2298
                },
                {
                    "id": 18,
                    "employeeGoalId": 16,
                    "title": "Make get out of debt and make a profit of 5",
                    "currentValue": -7,
                    "startValue": -7,
                    "endValue": 5,
                    "completedDateTime": null,
                    "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                    "lastUpdateUserId": 2298
                }
            ],
            "actions": {
                "canEditGoalProgressBar": false,
                "canEditGoalMilestoneProgressBar": true
            }
        }
    ],
    "persons": [
        {
            "employeeId": 123,
            "userId": null,
            "displayFirstName": "Poe",
            "lastName": "Panda",
            "photoUrl": "po-panda-photo.jpg"
        }
    ],
    "comments": [
        {
            "goalId": "11",
            "commentCount": 2
        },
        {
            "goalId": "16",
            "commentCount": 3
        }
    ]
}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!