Goals
Public API
List Goal Sharing Options
Provides a list of employees with whom the specified employee's goals may be shared.
OAuth Scopes: goal
get/api/v1/performance/employees/{employeeId}/goals/shareOptions
Request
- Base URLhttps://companySubDomain.bamboohr.com
- Auth
- HTTP basic
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopesgoal
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
employeeIdstring required
The internal employee ID of the employee whose goal sharing options are returned.
Query parameters
searchstring required
The search term used to filter employees returned. Will search name, internal employee ID, and email.
limitinteger
Maximum number of employees to return. Defaults to 10, maximum 100.
Response
The response content will be a JSON document with a list of available employees with whom the goals can be shared.
Changes
No recorded changes to this operation across all 2 revisions of this API.