Search for employees

This endpoint allows you to retrieve employee data based on specified criteria.
Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation.

Before using this endpoint:

1. Explore Read Employee data. Please ensure that you understand the employee field structure and the correct usage before using this endpoint.
2. Explore the People API reference page for information about rate limits, permissions, troubleshooting and more.
3. Note that only employee fields are supported. Table entries cannot be retrieved via this endpoint. Use Employee Tables endpoints for this.
4. Default fields. If no specific fields are requested, a default set of fields will be returned, as listed in the 200 response. IF you want to retrieve other fields, you will need to specify their field id in the body parameters. Please review the above documentation for further information.
5. Custom fields. To retrieve custom fields you need to specify their field id in the body parameters and ensure you habe the approriate permissions to the category. Please review the documentation mentioned above for further information.
6. Position fields cannot be retrieved using this endpoint. To pull 'Positions', use the Workforce Planning endpoints.

Testing notes:

1. Use the testing widget's Try It! option to test this endpoint.
2. Use the Examples > Request Example option to see how to initiate body parameters.
3. Explore the response payload using the Example in the Response on the right, to understand the structure. You can see the response for the human-readable format and for the machine-format (backend IDs).