List Goals
list_goalsRetrieve company and employee goals, using filters for employee, goal type, scope, status, and due dates to locate specific goal records.
Instructions
Get company and employee goals with scope, type, target/current values, completion and due dates.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| comments | No | Search for this text within the goal comments | |
| employee | No | Employee code to only return records for that particular employee | |
| goal_type | No | Comma separated goal types. Allowed values: number, currency, counter, percentage, objective | |
| goal_scope | No | Comma separated goal scopes. Allowed values: company, employee, other | |
| description | No | Search for this text within the goal description | |
| due_date_to | No | Only goals due on/before this date (format yyyy-mm-dd) | |
| 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. | |
| due_date_from | No | Only goals due on/after this date (format yyyy-mm-dd) | |
| goal_is_active | No | Only return active goals (true/false) | |
| updated_date_to | No | Only goals updated on/before this date (format yyyy-mm-dd) | |
| assigned_date_to | No | Only goals assigned on/before this date (format yyyy-mm-dd) | |
| goal_is_completed | No | Only return completed goals (true/false) | |
| updated_date_from | No | Only goals updated on/after this date (format yyyy-mm-dd) | |
| assigned_date_from | No | Only goals assigned on/after this date (format yyyy-mm-dd) |