Get Goals Aggregate (v1)

Deprecated. Use "Get Goals Aggregate (v1.1)" instead. 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.

OAuth Scopes: goal

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Request Url

https://{companyDomain}.bamboohr.com/api/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
        }
    ]
}
Path Params
string
required

The internal employee ID of the employee whose goals are aggregated.

Query Params
string

Filter goals by status. Accepts filter IDs returned by the filters endpoint (e.g. status-inProgress). If omitted or invalid, defaults to the first available filter. The API accepts arbitrary strings and returns 200.

Responses

403

The authenticated caller does not have permission to view goals for this employee.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json