DocumentationAPI Reference
API Reference

List Goal Comments

get
https://{companyDomain}.bamboohr.com/api/v1/performance/employees//goals//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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^\d+$

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

string
required
^\d+$

goalId is the goal ID for the specified employee.

Responses

403

The authenticated caller does not have permission to view comments for this goal, or the goal does not belong to this employee.

404

The specified goalId is invalid (non-positive integer).

Updated 3 months ago

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

Updated 3 months ago