List Employee Addresses
list_addressesRetrieve employee addresses across the organization. Filter by employee name, address type, or location.
Instructions
Get a flat list of employee addresses across employees. Individual employee addresses are also included in the get_employee response.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Match against the employee full name | |
| 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. | |
| address_type | No | Filter by address type name | |
| location_search | No | Match against address lines, suburb, state, post code, or country |