DocumentationAPI Reference
API Reference

List Goal Sharing Options

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

Provides a list of employees with whom the specified employee's goals may be shared.

OAuth Scopes: goal

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

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

Query Params
string
required

The search term used to filter employees returned. Will search name, internal employee ID, and email.

integer
1 to 100
Defaults to 10

Maximum number of employees to return. Defaults to 10, maximum 100.

Responses

400

The search parameter is invalid or empty.

403

Goals are not enabled, or the authenticated caller does not have permission to view sharing options for this employee.

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