v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Goals
Public API

Get Alignable Goal Options

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 authenticated caller. 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.

OAuth Scopes: goal

get/api/v1/performance/employees/{employeeId}/goals/alignmentOptions

Path parameters

employeeIdstring required

The internal employee ID of the employee whose alignable goal options are returned.

Query parameters

goalIdinteger

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.

Response

The response content will be a JSON document with a list of goals that are available alignment options.