List Employee Anniversaries
list_anniversariesRetrieve upcoming employee work anniversaries for active staff, with years of service. Filter by month range, department, or location, and forecast tenure for a future year.
Instructions
Get upcoming employee work anniversaries (active, non-terminated employees only) with years worked. Filter by month range and optionally forecast service length for a future year.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | No | Only return records within this group (note: the field is always called 'group' in the API even if renamed to Branch/Entity etc. in the app) | |
| 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 length of service in that year is returned | |
| employment_status | No | One or more employment status names (comma separated) |