List Employee Dependents
list_dependentsRetrieves employee dependents and next-of-kin records, including type, name, contact details, and date of birth. Supports filtering by employee, department, dependent type, and more.
Instructions
Get employee dependent / next-of-kin records including type, name, contact details and date of birth.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Return only dependents with this partial text within the name field | |
| comments | No | Return only dependents with this partial text within the comments field | |
| employee | No | Employee code to only return records for that particular employee | |
| department | No | One or more department names (separated by commas) to filter by | |
| max_records | No | Optional client-side limit on the number of records returned. Use to keep responses small when exploring data; the API itself does not paginate. | |
| dependent_type | No | Only list records matching this dependent type | |
| contact_details | No | Return only dependents with this partial text within the contact details field | |
| date_of_birth_to | No | Only dependents born on/before this date (format yyyy-mm-dd) | |
| date_of_birth_from | No | Only dependents born on/after this date (format yyyy-mm-dd) |