Get Employee Dependent
Changed onReturns the details of a single employee dependent by their dependent ID. The response is a JSON object with a top-level key "Employee Dependents" containing a single-element array. 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.
Path parameters
The numeric ID of the employee dependent to retrieve.
Headers
This endpoint can produce either JSON or XML.
Response
The requested employee dependent.
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