List Goal Comments

Returns comments for a goal, including each comment's ID, author, text, creation time, and edit/delete permissions. Use this endpoint before updating or deleting a comment when the user identifies a comment by text or says "my comment" rather than providing a comment ID.

OAuth Scopes: goal

get/api/v1/performance/employees/{employeeId}/goals/{goalId}/comments

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
- HTTP basic
- or OAuth 2
  Authorization code/authorize.php
  Token URL/token.php
  Scopesgoal
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/performance/employees/:employeeId/goals/:goalId/comments/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

employeeIdstring required

The internal employee ID of the employee the goal is associated with.

goalIdstring required

goalId is the goal ID for the specified employee.

Response

Returns up to 50 comments for the specified goal, ordered by creation date.

Example response

{
  "comments": [
    {
      "createdAt": "2025-04-10T15:36:38Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.