MergeHRISClient.Api.Employees.employees_list
You're seeing just the function
employees_list
, go back to MergeHRISClient.Api.Employees module for more information.
Link to this function
employees_list(connection, authorization, x_account_token, opts \\ [])
View SourceSpecs
employees_list(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, MergeHRISClient.Model.PaginatedEmployeeList.t()} | {:error, Tesla.Env.t()}
Returns a list of Employee
objects.
Parameters
- connection (MergeHRISClient.Connection): Connection to server
- authorization (String.t): Should include 'Bearer ' followed by your production API Key.
- x_account_token (String.t): Token identifying the end user.
- opts (KeywordList): [optional] Optional parameters
- :company_id (String.t): If provided, will only return employees for this company.
- :created_after (DateTime.t): If provided, will only return objects created after this datetime.
- :created_before (DateTime.t): If provided, will only return objects created before this datetime.
- :cursor (String.t): The pagination cursor value.
- :expand (String.t): Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- :include_deleted_data (boolean()): Whether to include data that was deleted in the third-party service.
- :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.
- :include_sensitive_fields (boolean()): Whether to include sensitive fields (such as social security numbers) in the response.
- :manager_id (String.t): If provided, will only return employees for this manager.
- :modified_after (DateTime.t): If provided, will only return objects modified after this datetime.
- :modified_before (DateTime.t): If provided, will only return objects modified before this datetime.
- :page_size (integer()): Number of results to return per page.
- :pay_group_id (String.t): If provided, will only return employees for this pay group
- :personal_email (String.t): If provided, will only return Employees with this personal email
- :remote_id (String.t): The API provider's ID for the given object.
- :team_id (String.t): If provided, will only return employees for this team.
- :work_email (String.t): If provided, will only return Employees with this work email
- :work_location_id (String.t): If provided, will only return employees for this location.
Returns
on success {:error, Tesla.Env.t} on failure