List Employee Birthdays
list_birthdaysRetrieve upcoming birthdays for active employees with calculated ages. Filter by month range or forecast ages for a future year.
Instructions
Get upcoming employee birthdays (active, non-terminated employees only) with calculated age. Filter by month range and optionally forecast ages for a future year.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| location | No | One or more location names (separated by commas) to filter by | |
| position | No | One or more position names (comma separated) | |
| end_month | No | Ending month of the range (1 = January ... 12 = December) | |
| 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. | |
| start_month | No | Starting month of the range (1 = January ... 12 = December) | |
| selected_year | No | 4-digit year. If a future year is given, the forecast age of the employee in that year is returned | |
| employment_status | No | One or more employment status names (comma separated) |