v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Benefits
Public API

List Employee Dependents

Returns 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

get/api/v1/employeedependents

Query parameters

employeeidinteger

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

AcceptHeaderParameter'application/xml' | 'application/json'

This endpoint can produce either JSON or XML.

Response

A collection of employee dependents.