v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBBenefits
Public API
Get Employee Dependent
Returns 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
get/api/v1/employeedependents/{id}
Path parameters
idinteger required
The numeric ID of the employee dependent to retrieve.
Headers
AcceptHeaderParameter'application/xml' | 'application/json'
This endpoint can produce either JSON or XML.
Response
The requested employee dependent.