DocumentationAPI Reference
API Reference

Get Alignable Goal Options

get
https://{companyDomain}.bamboohr.com/api/v1/performance/employees//goals/alignmentOptions

Returns goals that can be used as alignment targets. When a goalId query parameter is provided, the currently aligned goal is included in the results even if it would otherwise be excluded. When goalId is omitted, returns alignment options for the API user. This endpoint is permission-sensitive: the caller may be able to view a goal through list-goals or get-goal-aggregate but still receive 403 here if they lack permission to view alignment options for the selected goal. Treat 403 as "alignment options are permission-restricted," not as proof that the goal ID is invalid.

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

employeeId is the employee ID to get alignable goal options for.

Query Params
integer

Optional goal ID whose current alignment should be included in the results. Only pass a goal ID that belongs to the specified employee. If this endpoint returns 403 for an otherwise visible goal, report that alignment options are restricted by permissions rather than treating the goal ID as invalid.

Responses

400

The provided goalId does not belong to the specified employee.

403

The employeeId resolves to 0 (invalid path segment), or the API user lacks permission to view the specified goal.

404

The provided goalId is zero or non-positive after integer cast (e.g. goalId=0, goalId=-1, or a non-numeric value such as goalId=abc).

Updated 2 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 2 months ago