List Employee Dependents
Changed onReturns employee dependents for the company. When employeeid is provided, only dependents for that employee are returned. When omitted, all dependents across all employees are returned. The response is a JSON object with a top-level key "Employee Dependents" containing an array of dependent objects. SSN and SIN are returned as masked values (e.g. "xxx-xx-1234"). State and country are returned as full names. Supports both JSON and XML response formats via the Accept header. Requires Benefits Administration permissions.
OAuth Scopes: employee:dependent, employee:dependent:ssn
Request
- Base URLhttps://companySubDomain.bamboohr.com
- Auth
- HTTP basic
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopesemployee:dependent:ssn
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopesemployee:dependent
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The internal employee ID to filter dependents by. When provided, only dependents for that employee are returned. When omitted, all company dependents are returned.
Headers
This endpoint can produce either JSON or XML.
Response
A collection of employee dependents.
Changes
- info
the security scope
employee:dependent:ssnwas added to the endpoint's security schemeoauth - info
the security scope
employee:dependentwas removed from the endpoint's security schemeoauth
- info