Factorial + Microsoft Outlook

Factorial + Microsoft Outlook integrations

Invite new employees in Factorial and send emails in Microsoft Outlook

Effortlessly manage your onboarding process with this easy-to-use workflow. When a new employee invitation is sent out from Factorial, an email is instantly dispatched from your Microsoft Outlook. Eliminate manual tasks, streamline your HR operations, and welcome your new team members in a timely and efficient manner.

When this happens...
Invites an EmployeeTriggered when an employee is invited.
TriggerInstant
automatically do this!
Send EmailSend an email from your Outlook account.
ActionWrite

Start free with email

Start free with Google

Free forever for core features
14 day trial for premium features & apps

More things you can do with Factorial and Microsoft Outlook

Discover other triggers and actions you can use with Factorial and Microsoft Outlook

- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It

- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It

- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Identifier of the webhook subscription - [id]
  Required
- URL where the webhook payload will be sent - [target_url]
- Type of the webhook subscription - [subscription_type]
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Action
Write
- Company id of the application - [company_id]
- Application first name - [first_name]
  Required
- Application last name - [last_name]
  Required
- Application job posting id - [ats_job_posting_id]
  Required
- Application candidate email - [email]
  Required
- Application candidate phone - [phone]
- Application source - [source]
- Application medium - [medium]
- Application cover letter - [cover_letter]
- gender of the candidate. - [gender]
- Application consent talent pool - [consent_to_talent_pool]
- Answers_one
Action
Write
- Application author id - [author_id]
- Application author type - [author_type]
- Application id - [id]
  Required
- Application is qualified - [qualified]
- Application phase id - [ats_application_phase_id]
- Application disqualified reason - [disqualified_reason]
- Application candidate phone - [phone]
- Application rejection reason id - [ats_rejection_reason_id]
- Application source - [source]
- Application source id - [source_id]
Action
Write
- identifier of the candidate.
  Required
Action
Write
- first name of the candidate. - [first_name]
  Required
- last name of the candidate. - [last_name]
  Required
- email of the candidate. - [email]
- company identifier, refers to /core/me endpoint. - [company_id]
  Required
- is the candidate part of talent pool? - [talent_pool]
- date when the consent was given. - [consent_given_at]
- source of the candidate. - [source]
- specifies additional details related to the source of the candidate, such as the referrer name for example if the source is referred. - [medium]
- phone number of the candidate. - [phone_number]
- personal web resource from the candidate. - [personal_url]
- gender of the candidate. - [gender]
Action
Write
- identifier of the feedback
  Required
Action
Write
- the ID of the candidate to whom the new feedback will be associated. - [ats_candidate_id]
  Required
- the overall rating from 1 to 5 to be given to the candidate's application. - [rating]
- the ID of the application related to the feedback. - [ats_application_id]
- the ID of the phase within the application related to the feedback. - [ats_application_phase_id]
- a string describing the feedback provided. - [description]
- the IDs of the accesses for sending notifications if they have it enabled. They must have permissions to see the assosiated application. - [mention_ids]
- IDs of the form to which the feedback belongs if the evaluation forms feature is active. - [ats_evaluation_forms_id]
Action
Write
- identifier of the job posting
  Required
Action
Write
- [title]
  Required
- [description]
- [contract_type]
- [workplace_type]
- [status]
  Required
- [schedule_type]
- [team_id]
- [location_id]
- [salary_format]
- [salary_from_amount_in_cents]
- [salary_to_amount_in_cents]
- [cv_requirement]
  Required
- [cover_letter_requirement]
  Required
- [phone_requirement]
  Required
- [photo_requirement]
  Required
- [salary_period]
Action
Write
- Id of the break configuration - [id]
  Required
- Status of the break configuration if enabled or not - [enabled]
Action
Write
- identifier
  Required
Action
Write
- [employee_id]
  Required
- [request_type]
  Required
- [reason]
- [date]
- [clock_in]
- [clock_out]
- [workable]
- [attendance_shift_id]
- [reference_date]
- [time_settings_break_configuration_id]
- [location_type]
- [observations]
Action
Write
- id
  Required
Action
Write
- [date]
  Required
- [description]
- [hours_amount]
- [employee_id]
  Required
- [author_id]
  Required
Action
Write
- Ids of the employees to be autofilled - [employee_ids]
  Required
- Date to start autofilling - [start_on]
  Required
- Date to end autofilling - [end_on]
  Required
- Source of the shift creation - [source]
Action
Write
- Employee id of the break - [employee_id]
- Current time of the break - [now]
  Required
- Observations of the break - [observations]
- Time settings configuration id of the break - [time_settings_break_configuration_id]
Action
Write
- Employee identifier - [employee_id]
- Clock out time - [now]
  Required
- Latitude from where user clocked in - [latitude]
- Longitude from where user clocked in - [longitude]
- Location accuracy - [accuracy]
- Notes on the shift record - [observations]
Action
Write
- Id of the shift - [id]
  Required
- Time of the clock in - [clock_in]
- Time of the clock out - [clock_out]
- Date of the shift - [date]
- reference date of the shift - [reference_date]
- Comments added to the shift - [observations]
- Type of the location - [location_type]
- Id of the location related - [workplace_id]
- Id of the break configuration - [time_settings_break_configuration_id]
Action
Write
- Employee identifier - [employee_id]
  Required
- Clock in or out Timestamp - [clock_time]
  Required
- Place where user has clocked in - [location_type]
- Notes on the shift record - [observations]
Action
Write
- id
  Required
Action
Write
- [contract_version_id]
  Required
- [contracts_taxonomy_id]
  Required
- [description]
- [compensation_type]
- [amount]
- [unit]
- [sync_with_supplements]
- [payroll_policy_id]
- [recurrence_count]
- [starts_on]
- [recurrence]
- [first_payment_on]
- [calculation]
- [time_condition]
- [minimum_amount_of_hours]
- [minimum_amount_of_hours_in_cents]
Action
Write
- contract version identifier. - [id]
  Required
- employee identifier, refers to /employees/employees endpoint. - [employee_id]
- the day the specific contract starts, in case of hiring the same than starts_on. - [effective_on]
- the day the employee is hired. - [starts_on]
- the day the employee is terminated. - [ends_on]
- the frequency of the working hours. - [working_hours_frequency]
- the days of the week the employee works. - [working_week_days]
- the amount of hours the employee works. - [working_hours]
- the frequency of the salary payment. - [salary_frequency]
- the amount of money the employee earns. - [salary_amount]
- job title of the employee. - [job_title]
- cotization group identifier. - [es_cotization_group]
- professional category identifier. - [es_professional_category_id]
- education level identifier. - [es_education_level_id]
- contract type identifier. - [es_contract_type_id]
- working day type identifier. - [es_working_day_type_id]
- a flag that indicates if the employee has a trial period. - [has_trial_period]
- when the trial period ends. - [trial_period_ends_on]
Action
Write
- id
  Required
Action
Write
- Title for option - [label]
  Required
- Flag to make the option available - [is_active]
- Custom Fields identifier - [field_id]
  Required
Action
Write
- [id]
- [value]
Action
Write
- Schema name - [name]
  Required
- Company identifier where this schema belongs - [company_id]
  Required
- Custom field identifier - [effective_at_id]
- Manages visibility of the schema - [hidden]
  Required
- Schema position within employee profile - [position]
- Schema slug - [usage_group_slug]
Action
Write
- id
  Required
Action
Write
- list of document identifiers. - [document_ids]
  Required
Action
Write
- list of document identifiers. - [document_ids]
  Required
Action
Write
- Company ID - [company_id]
  Required
- Folder id - [id]
  Required
- Folder name - [name]
  Required
Action
Write
- company id of the employee, you can get it in companies/legal_entities endpoint. - [company_id]
  Required
- name of the employee. - [first_name]
  Required
- last name of the employee. - [last_name]
  Required
- personal email of the employee. - [email]
  Required
- the day the specific contract starts, in case of hiring the same than contract_starts_on. - [contract_effective_on]
- the day the employee is hired. - [contract_starts_on]
- the day the contract ends. - [ends_on]
- gender of the employee (male | female). - [gender]
- national identifier number. - [identifier]
- type of identifier (ex passport). - [identifier_type]
- identifier expiration date. - [identifier_expiration_date]
- birthday of the employee. - [birthday_on]
- nationality country code of the employee (Spain ES, United Kingdom GB). - [nationality]
- address of the employee. - [address_line1]
- address of the employee. - [address_line_2]
- postal code of the employee. - [postal_code]
- city of the employee. - [city]
- state/province/region of the employee. - [state]
- country code of the employee (Spain ES, United Kingdom GB). - [country]
- bank account number of the employee. - [bank_number]
- code to identify banks and financial institutions globally. - [swift_bic]
- id of manager, you can get the manager_id from employees endpoint. - [manager_id]
- id of manager, you can get the manager_id from employees endpoint. - [timeoff_manager_id]
- legal entity of the employee, references to companies/legal_entities. - [legal_entity_id]
- identity number or string used inside a company to internally identify the employee. - [company_identifier]
- team id of the employee. - [team_id]
- location id of the employee, references to locations/locations. - [location_id]
- social security number of the employee. - [social_security_number]
- does the employee have a trial period? - [has_trial_period]
- when the trial period ends. - [trial_period_ends_on]
- name of the emergency contact. - [contact_name]
- phone number of the emergency contact. - [contact_number]
- phone number of the employee. - [phone_number]
- A3Innuva employee code. - [a3_innuva_code]
- A3Nom employee code. - [a3_nom_code]
Action
Write
- id of the unconfirmed employee - [id]
  Required
- id of the company - [company_id]
  Required
Action
Write
- id of the employee. - [id]
  Required
Action
Write
- [employee_id]
  Required
- Memberships_one
- [company_id]
  Required
Action
Write
- id
  Required
Action
Write
- id
  Required
Action
Write
- name of the location - [name]
  Required
- country code of the location - [country]
  Required
- whether the location is the main one - [main]
- City of the location - [city]
- State of the location - [state]
- phone number of the location - [phone_number]
- Postal code of the location - [postal_code]
- Address line 1 of the location - [address_line_one]
- Address line 2 of the location - [address_line_two]
- latitude of the location - [latitude]
- longitude of the location - [longitude]
- timezone of the location - [timezone]
  Required
- radius of the location - [radius]
- company identifier - [company_id]
  Required
- siret of the location (only for France) - [siret]
Action
Write
- [id]
  Required
- [name]
  Required
Action
Write
- [id]
  Required
Action
Write
- payroll employee identifier - [id]
  Required
- social security number of the employee - [social_security_number]
- tax id of the employee - [tax_id]
- country code of the employee pt | it | de - [country]
  Required
Action
Write
- Family situation id. - [id]
  Required
- Employee id. - [employee_id]
  Required
- Civil status of the employee. - [civil_status]
- Number of dependants of the employee. - [number_of_dependants]
Action
Write
- id
  Required
Action
Write
- Code Value - [code]
  Required
- Related object ID. Used together with codeable_type - [codeable_id]
  Required
- Related object type. Used together with codeable_id - [codeable_type]
  Required
- Integration name - [integration]
  Required
Action
Write
- id
  Required
Action
Write
- Supplement amount in cents - [amount_in_cents]
  Required
- The employee id of the suplement - [employee_id]
  Required
- Supplement effective on date following the format YYYY-MM-DD - [effective_on]
  Required
- Supplement contract taxonomy id - [contracts_taxonomy_id]
  Required
- Supplement contract compensation id - [contracts_compensation_id]
- Supplement payroll policy period id - [payroll_policy_period_id]
- Supplement unit - [unit]
- Supplement worked days - [worked_days]
Action
Write
- Review process ID - [process_id]
  Required
- Review process target ID - [target_id]
  Required
Action
Write
- Evaluation ID - [id]
  Required
- New reviewer access ID - [new_reviewer_access_id]
  Required
Action
Write
- Review owner ID
  Required
Action
Write
- Review process ID
  Required
Action
Write
- Review process ID - [id]
  Required
- Reviewer strategies to remind about - [evaluation_types]
Action
Write
- Review process ID - [id]
  Required
- New deadline of the review process - [ends_at]
  Required
Action
Write
- Review process ID - [id]
  Required
Action
Write
- Review process ID - [id]
  Required
Action
Write
- Review process ID - [id]
  Required
- New name of the review process - [name]
- New description of the review process - [description]
Action
Write
- Review process ID - [id]
  Required
- New deadline of the review process - [ends_at]
  Required
Action
Write
- Review process ID - [id]
  Required
- New review types to be applied - [reviewer_strategies]
  Required
Action
Write
- Review process ID - [id]
  Required
- Condition that defines the employees that will be evaluated (participants) - [target_strategy]
- IDs of target strategy groups selected - [arguments]
Action
Write
- Review process ID - [performance_review_process_id]
  Required
- List of access IDs to be added as participants - [targets_access_ids]
  Required
Action
Write
- [id]
  Required
- [evaluation_ids]
  Required
Action
Write
- Review process ID - [performance_review_process_id]
  Required
- Reviewer strategy to update the questionnaire for - [strategy]
  Required
- Questionnaire_content_one
Action
Write
- identifier of the comment
  Required
Action
Write
- identifier of the post - [post_id]
  Required
- Text of the comment - [text]
  Required
Action
Write
- identifier of the group.
  Required
Action
Write
- title of the group. - [title]
  Required
- description of the group. - [description]
  Required
- Identifier of the company, this value can be retrieved from core/me endpoint - [company_id]
  Required
Action
Write
- identifier of the post - [id]
  Required
- title of the post - [title]
- description of the post - [description]
- group identifier of the post, references to posts/groups endpoint - [post_group_id]
- allow comments and reactions on the post - [allow_comments_and_reactions]
Action
Write
- [flexible_time_record_id]
  Required
Action
Write
- [content]
  Required
- [flexible_time_record_id]
  Required
Action
Write
- [id]
  Required
- [imputed_minutes]
  Required
Action
Write
- [id]
  Required
Action
Write
- [id]
  Required
Action
Write
- Mandatory to pass a name of the project. - [name]
  Required
- Optional unique code for the project to be identifiable and searchable. - [code]
- Optional start date for the project. If given must be in iso-8601 format (YYYY-MM-DD). - [start_date]
- Optional due date for the project. If given must be in iso-8601 format (YYYY-MM-DD). - [due_date]
- Project status. Can be active or closed - [status]
- Optional param to define the kind of assignation the project has. Can be manual or company - [employees_assignment]
- [project_admins]
- [project_managers]
- [is_billable]
- [fixed_cost_cents]
- [budget_allocation]
- [legal_entity_id]
- [budget_allocation_cents]
- [fee_amount_cents]
Action
Write
- [ids]
  Required
Action
Write
- [id]
  Required
- [name]
  Required
- [content]
- [starts_on]
- [follow_up]
  Required
- [due_on]
- [assignee_ids]
- [project_id]
  Required
- [subproject_id]
- [files_to_add]
- [files_to_remove]
- [status]
Action
Write
- **DEPRECATED** in favor of project_ids. Please use project_ids instead - [project_id]
- Set of project_ids to assign to the employees specified in the next param. - [project_ids]
- Set of a employee_ids that must be **assigned** after execution. - [employee_ids]
  Required
Action
Write
- The id of the project to assign the employee project worker. - [project_id]
  Required
- The id of the employee to be assigned to the project. - [employee_id]
  Required
Action
Write
- id
  Required
Action
Write
- [id]
  Required
- [name]
  Required
Action
Write
- Items_one
Action
Write
- [project_worker_id]
  Required
- [attendance_shift_id]
  Required
- [subproject_id]
Action
Write
- List of shift identifiers - [ids]
- Start date for the shift list - [start_at]
- End date for the shift list - [end_at]
- Lsit of the employee identifiers - [employee_ids]
- Access identifier of the author fo the bulk delete action - [author_id]
  Required
Action
Write
- [name]
- Start date of the shift - [start_at]
  Required
- End date of the shift - [end_at]
  Required
- Shift notes - [notes]
- Employee identifier - [employee_id]
  Required
- Location identifier - [location_id]
- Location work area identifier - [work_area_id]
- Company identifier - [company_id]
  Required
Action
Write
- identifier of the task - [task_id]
  Required
- file to attach to the task - [file]
  Required
Action
Write
- a list of task ids. - [ids]
  Required
Action
Write
- [content]
  Required
- [author_id]
  Required
- [resource_id]
  Required
- [company_id]
  Required
- [mentioned_access_ids]
Action
Write
- id of a task. - [id]
  Required
- name of task. - [name]
  Required
- description of the task. - [content]
- expiration date of the task. - [due_on]
- employees assigned to the task, assignee_id references to employee_id. - [assignee_ids]
- status of the task (todo | in_progress | done | discarded). - [status]
Action
Write
- Membership id.
  Required
Action
Write
- Team id. - [team_id]
  Required
- Employee id. - [employee_id]
  Required
- Makes the employee a lead of the team. - [lead]
Action
Write
- id of the team - [id]
  Required
- name of the team - [name]
- Description of the team - [description]
- Avatar of the team - [avatar]
Action
Write
- id
  Required
Action
Write
- Employee Id - [employee_id]
  Required
- Allowance Id - [timeoff_allowance_id]
  Required
- How many units multiplied by 100 do you want to add/substract. Can be positive or negative - [days_in_cents]
  Required
- A free text field to add a description to the incidence - [description]
- When does the incidence take effect. This is related to the allowance cycle. - [effective_on]
  Required
- Which counter does the incidence affect. Can be "accrued" or "available" - [target_balance]
  Required
- When set to true, it prevents notifications being sent to employee when this incidence is created - [_skip_notifications]
Action
Write
- id
  Required
Action
Write
- Only for Allowances based on worked time. It represents how many units you need to work to be granted allowance units - [accrued_denominator_in_cents]
- Only for Allowances based on worked time. It represents how many units you are given per unit of time worked - [accrued_factor_in_cents]
- When can the accrued units be spent. - [accrued_units_availability]
  Required
- Sets the allowance units. Can be "days" or "hours" - [allowance_type]
  Required
- Indicates how the allowance units are accrued. For example all_days means all allowance days are given on the first day of the cycle. - [available_days]
  Required
- How many units can carry over between cycles multiplied by 100 - [carry_over_units_in_cents]
- This setting flags if units taken during a bank holiday should be deducted or not from allowance. - [count_holiday_as_workable]
  Required
- How many months does each allowance cycle last - [cycle_length]
- When does the cycle start. - [cycle_start]
  Required
- Indicates if the allowance is based on working on calendar days. - [days_type]
  Required
- When does the carryover expire in months. - [expire_in_months]
- Defines duration of the allowance cycles. Can be "yearly", "monthly_flexible" or "lifetime" - [frequency]
- Base amount of holiday allowance units multiplied by 100 - [holiday_allowance_in_cents]
  Required
- An array of leave type ids associated with that allowance - [leave_type_ids]
  Required
- Maximum the allowance can reach on accrued - [maximum_amount_in_cents]
- Allowance name set by the user - [name]
  Required
- Whether the allowance allows to request more days than available. - [negative_counter_type]
  Required
- Indicates the position in the allowance when rendering them in UI - [position]
- Whether the allowance has proration enabled or not. - [proration_type]
  Required
- Whether the allowance days are prorated or not - [pto_proratio_enabled]
  Required
- Configures how leaves duration is handled. - [range_type]
- How the accrued units of the allowance are rounded. It depends if the allowance is set in hours or days. - [rounding]
  Required
- This field configures the type of allowance (fixed balance, based on worked time) - [source_units]
  Required
- In case the allowance has tenure periods, when is this tenure applied. - [tenure_period_transition]
- Whether the allowance has tenure periods enabled or not. - [tenure_periods_enabled]
- Tenure_periods_one
- The Id of the policy to which the allowance belongs to - [timeoff_policy_id]
  Required
- Flag to indicate if there is unlimited accrual. - [unlimited_accrued_hours]
  Required
- Flag to indicate if there is unlimited carry over. - [unlimited_carry_over]
  Required
- Boolean to flag if carryover does not expire - [unlimited_carry_over_expiration]
  Required
- Flag to indicate that the allowance has unlimited available days - [unlimited_holidays]
  Required
Action
Write
- [id]
  Required
- Name of the blocked period. - [name]
  Required
- List of leave type identifiers for which employees can not request timeoff edited - [leave_type_ids]
  Required
- Time_periods_attributes_one
- Type of access group - [strategy]
  Required
- List of employees manually selected - [members]
- [query]
- List of team identifiers which the selected employees belong to - [team_ids]
- List of locations workplace identifiers where the employees are located - [location_ids]
- List of legal entity identifiers which the selected employees belong to - [legal_entity_ids]
Action
Write
- Identifier of the Leave - [id]
  Required
Action
Write
- id
  Required
Action
Write
- The employee id of the leave - [employee_id]
  Required
- The leave type id - [leave_type_id]
- The description of the leave - [description]
- The valid start date of the leave following the format YYYY-MM-DD - [start_on]
  Required
- The valid end date of the leave following the format YYYY-MM-DD - [finish_on]
- If the leave is in: [beggining_of_day, end_of_day] - [half_day]
- The start time of a leave - [start_time]
- The hours amount in cents of a leave - [hours_amount_in_cents]
- The medical leave type - [medical_leave_type]
- The effective on date of a leave following the format YYYY-MM-DD - [effective_on]
- The medical discharge reason of a leave - [medical_discharge_reason]
- The colegiate number of a leave - [colegiate_number]
- If the leave has previous relapse - [has_previous_relapse]
- The leave relapse id - [relapse_leave_id]
- The leave relapse on date following the format YYYY-MM-DD - [relapse_on]
- The leave accident on date following the format YYYY-MM-DD - [accident_on]
- The leave paternity birth on date following the format YYYY-MM-DD - [paternity_birth_on]
Action
Write
- Identifier of the leave type to update - [id]
- Whether the leave type accrues over time - [accrues]
- Whether approval is required for this leave type - [approval_required]
- A unique identifier for the leave type - [identifier]
- Whether an attachment is required for this leave type - [attachment]
- The color associated with this leave type (hex code) - [color]
- The name of the leave type - [name]
- Whether the leave type is visible to employees - [visibility]
- Whether the leave type is workable (can be worked on during leave) - [workable]
- Whether the leave type is payable - [payable]
- Whether the attachment is mandatory or a status description (boolean or string) - [is_attachment_mandatory]
- Whether half-day units are enabled for this leave type - [half_days_units_enabled]
- Maximum days in cents that can be taken - [max_days_in_cents]
- Minimum days in cents that must be taken - [min_days_in_cents]
- Whether the leave type is active - [active]
- Whether endless leave is allowed - [allow_endless]
- Whether the leave type is restricted - [restricted]
- Description of the leave type - [description]
- Whether additional details are required for the leave type - [details_required]
Action
Write
- Id of the policy to delete.
  Required
Action
Write
- The name of the policy. - [name]
  Required
- If the policy is the main policy. - [main]
- Policy description. - [description]
- Company ID. - [company_id]
Action
Write
- id
  Required
Action
Write
- Start date of the planning version - [effective_at]
  Required
- Type of planning tool (shift_management, work_schedules, contract_hours) - [planning_tool]
  Required
- Amount of rest days per week if applicable (in cents) - [number_of_rest_days_in_cents]
- Employee identifier - [employee_id]
  Required
- Work schedule identifier to include if applicable - [schedule_id]
Action
Write
- [name]
  Required
- [paid]
  Required
Action
Write
- [name]
  Required
- [company_id]
  Required
Action
Write
- [ids]
  Required
- [notify]
  Required
Action
Write
- id
  Required
Action
Write
- [name]
  Required
- [training_id]
  Required
- [description]
- [training_class_id]
- [starts_at]
- [ends_at]
- [due_date]
- [duration]
- [modality]
- [link]
- [location]
- [subsidized]
- [recurrent]
- Reminders_one
Action
Write
- [ids]
  Required
Action
Write
- [ids]
  Required
Action
Write
- id
  Required
Action
Write
- Name of the training - [name]
  Required
- Code of the training - [code]
- Description of the training - [description]
  Required
- External provider of the training - [external_provider]
- External training - [external]
  Required
- [category_ids]
- Competency ids of the training - [competency_ids]
- The person that creates the training - [author_id]
- [employee_id]
- [cost]
- [subsidized_cost]
- [cost_decimal]
- [subsidized_cost_decimal]
- Year of the training - [year]
  Required
- Company identifier of the training - [company_id]
- Attachments_one
- The training validity period - [valid_for]
- Objectives of the course - [objectives]
Action
Write
- [overlap_period_id]
  Required
- Day_configurations_one
Action
Write
- [author]
  Required
- [id]
  Required
- [update_params]
  Required
Action
Write
- [name]
- [id]
  Required
- [author]
  Required
Action
Write
- [id]
  Required
Action
Write
- Identifier of the webhook subscription
  Required
Action
Search
- Identifier of the answers
  Required
Action
Search
- Application phases identifiers
  Required
Action
Search
- Application ids to retrieve
  Required
Action
Search
- list of candidate identifiers.
  Required
Action
Search
- a list of source identifiers.
  Required
Action
Search
- List of IDs of the evaluation forms to be fetched.
  Required
Action
Search
- retrieve only the feedbacks that match the IDs passed in the request.
  Required
Action
Search
- Identifiers of the hiring stages
  Required
Action
Search
- identifier of the job posting
  Required
Action
Search
- identifier
  Required
Action
Search
- Rejection reasons identifiers
  Required
Action
Search
- The break configuration ids to retrieve
  Required
Action
Search
- filter by ids.
  Required
Action
Search
- Employee ids to filter the open shifts by.
Action
Search
- id
  Required
Action
Search
- filter by ids.
  Required
Action
Search
- A list of incidence identifiers.
- A list of legal entities identifiers.
- A list of statuses.
- Get the incidence (aka employee update) that start safter this date (included).
- Get the incidence (aka employee update) that ends before this date (included).
- A list of types. It can be any of the following address, bank, cost_center, contract, gender, hiring, id, irpf, legal_entity, manual_incidence, name, nationality, parental, phone_number, sick, tax_id, termination, workplace
- sort_by
- direction
- Filter the result by the name of the employee.
- employee_ids
- Boolean that filters incidences that does or does not contains messages.
- Filter by message sender.
- custom_leave_name
Action
Search
- identifier of the legal entity
- identifier of the employees asigned to the legal entity
- identifier of the companies to which the legal entity belongs
- country code of the legal entity
Action
Search
- ids
- contract_version_ids
Action
Search
- list of contract version identifiers.
- list of employee identifiers, refers to /employees/employees endpoint.
- filters contracts by effective_on field.
Action
Search
- list of contract type identifiers.
Action
Search
- list of contract type identifiers.
Action
Search
- list of contract type identifiers.
Action
Search
- filter by employee ids.
Action
Search
- list of contract type identifiers.
  Required
Action
Search
- id
  Required
Action
Search
- Field identifiers
  Required
Action
Search
- Options identifiers
  Required
Action
Search
- Resource field identifiers
  Required
Action
Search
- id
  Required
Action
Search
- Schemas identifiers
  Required
Action
Search
- Values identifiers
  Required
Action
Search
- list of document identifiers.
  Required
Action
Search
- ids of the folders.
  Required
Action
Search
- filter by employee ids.
  Required
Action
Search
- filter by absence incidence ids.
  Required
Action
Search
- filter by contract change incidence ids.
  Required
Action
Search
- filter by new hire incidence ids.
  Required
Action
Search
- filter by personal change incidence ids.
  Required
Action
Search
- retrieve only the `employee updates` that matches the `ids` passed in the request.
  Required
Action
Search
- filter by termination incidence ids.
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- The IDs of the per diem to read.
  Required
Action
Search
- Search ledger accounts by ID
  Required
Action
Search
- ids
- company_id
- legal_entity_ids
- include_actives_on_date
- search
Action
Search
- Company holiday ids
- Location id
- Team id
- Start date
- End date
Action
Search
- ids
- role_ids
Action
Search
- ids
Action
Search
- ids
- employee_ids
Action
Search
- only_non_archived
  Required
- ids
- location_ids
Action
Search
- company_id
  Required
- integration_id
  Required
Action
Search
- filters by country code pt | it | de
  Required
- ids
- filters by employee identifiers
- legal_entities_ids
Action
Search
- employee ids.
Action
Search
- The policy period ids to retrieve
- Valid date following the format YYYY-MM-DD
- Valid date following the format YYYY-MM-DD
- The employee ids to retrieve
- The compensation id to retrieve
- ids
- The legal entities id to retrieve
Action
Search
- Filter by action plan IDs
- Filter by review process IDs
- Filter by review process target IDs
Action
Search
- Filter by company IDs
Action
Search
- Filter by employee score scale IDs
Action
Search
- Filter by employee score IDs
- Filter by review process IDs
- Filter by evaluation IDs
- Filter by employee access IDs
- Filter by who scored the employee
- review_process_target_ids
Action
Search
- Filter by review evaluation IDs
Action
Search
- Filter by evaluation IDs
  Required
Action
Search
- Filter by review process IDs
- Filter by review process name
Action
Search
- performance_review_process_ids
- access_ids
Action
Search
- Filter by review process target IDs
  Required
Action
Search
- Filter by review process IDs
  Required
Action
Search
- Review process ID (only one ID is allowed)
- ids
Action
Search
- identifiers of the post
- identifiers of the comment
Action
Search
- identifier of the group.
Action
Search
- group identifiers of the posts
- date from which posts will be retrieved
- date until which the posts will be retrieved
- identifiers of the post
Action
Search
- ids
- start_date
- end_date
- expense_ids
- project_ids
- subproject_ids
- updated_after
- employee_user_name_like
- project_worker_ids
Action
Search
- start_date
  Required
- end_date
  Required
- project_ids
Action
Search
- ids
- flexible_time_record_id
Action
Search
- ids
- project_worker_ids
- starts_on
- ends_on
- updated_after
Action
Search
- If true we will perform the minutes calculations and will be return the total inputed_minutes. If false, 0 will be returned and no minutes calculations will be performed.
  Required
- Retrieve only the projects that matches the ids provided in the request.
- name
- Retrieve only the projects that match the name or coded passed in the request.
- Retrieve only the projects that were created or updated after the date provided in the request.
- Retrieve only the projects that are related to the legal entity passed in the request.
- Retrieve only the projects that are not related to any client.
- Retrieve only the projects that have the total cost in the currency passed in the request.
Action
Search
- Retrieve only the projects tasks that matches the ids passed in the request.
- Retrieve only the projects tasks from the projects that matched the ids passed in the request.
- Retrieve only the projects tasks from the subprojects that matched the ids passed in the request.
- Retrieve only the projects tasks with the status completed.
  Required
- Retrieve only the projects tasks that are overdue.
  Required
- Retrieve only the projects tasks that their name match with the content passed as argument.
  Required
- Retrieve only the project tasks that their due status match with the content passed as argument.
  Required
- Retrieve only the projects tasks from the clients that matched the ids passed in the request.
- task_ids
Action
Search
- Retrieve only the project workers that matches the ids provided in the request.
- Retrieve only the project workers that matches the project_ids provided in the request.
- Retrieve only the project workers that matches the subproject_ids provided in the request.
- Retrieve the project workers that are not assigned to any subproject (can be combined with subproject_ids).
- Retrieve only the project workers that are related to the employee_ids provided in the request.
- Retrieve project workers that are assigned if true or in not-assigned status if false.
- Retrieve the project workers that are assigned to active projects if turew or closed projects if false.
- Retrieve only the project workers that matches the given employee's name provided in the request.
- If true we will perform the minutes calculations and will be return the total inputed_minutes. If false, 0 will be returned and no minutes calculations will be performed.
- include_cost
- Retrieve only the project workers that were created or updated after the date provided in the request.
- include_labor_cost
Action
Search
- ids
- project_ids
- name
- include_no_subproject
- include_inputed_minutes
- include_cost
- updated_after
Action
Search
- Time record ids to retrieve
- Project worker ids to retrieve
- Subproject ids to retrieve
- Attendance shift ids to retrieve
- Employee ids to retrieve
- Month to filter
- Year to filter
- updated_after
Action
Search
- List of shift identifiers
- List of shift identifiers to exclude
- List of employee identifiers
- List of location identifiers
- Start date to find shifts from
- End date to find shifts to
- To retrieve only published shifts
Action
Search
- identifier of the task
  Required
- identifiers of the files
Action
Search
- retrieve only the tasks that match the IDs passed in the request.
- retrieve the tasks that have a company_id associated
- retrieve the tasks that have an assignee_id associated, assignee_id references to employee_id.
- filter by tasks that have a due date.
- filter by tasks that have expired or are still due.
- filter by tasks that with an especific status (todo | in_progress | done | discarded).
- retrieve tasks where the user is affectee or assignee
Action
Search
- Membership ids.
- Whether the employee is a lead of the team or not
- Team ids.
- Employee ids.
Action
Search
- ids
Action
Search
- ids
- employee_ids
- timeoff_allowance_ids
Action
Search
- An array of allowance ids to look for
- Filter allowances by Time off policy id
- Filter by only overtime allowances
Action
Search
- employee_id
  Required
- allowance_id
  Required
- reference_date
  Required
- ids
Action
Search
- ids
- company ids
Action
Search
- Retrieve leave types
  Required
- Retrieve leave duration
  Required
- The leave ids to retrieve
- The employee ids to retrieve
- The leave type id to retrieve
- Valid date following the format YYYY-MM-DD
- Valid date following the format YYYY-MM-DD
- Retrieve only active leaves
- Retrieve approved leaves
- Retrieve pending leaves
- Retrieve workable leaves
Action
Search
- Identifiers of the leave types
- Identifiers of the companies
- Whether the leave type is active
- Whether the leave type is payable
- A unique identifier for the leave type, or an array of identifiers
- Identifier of the employee
- A reference date for the leave type
- Identifier of a specific leave type
Action
Search
- The policies ids to retrieve.
- The company ids to retrieve policies.
Action
Search
- employee id
  Required
- reference date
  Required
Action
Search
- active
  Required
- ids
Action
Search
- ids
Action
Search
- session id
  Required
- ids
- search
- team id
Action
Search
- session id
- id
- ids
- session access membership ids
- access ids
Action
Search
- This field is used to filter those sessions whose id match with the given.
- This field is used to filter those sessions whose belong to these trainings.
- This field is used to filter those sessions whose name include some of the text written.
- This field is used to filter those sessions whose starts date is after the given.
- This field is used to filter those sessions whose starts date is before the given.
- access_id associated to the employee, refers to employees/employees endpoint.
- This field is used to filter those sessions whose belong to this training groups.
- When this field is active, it filters and orders those sessions taht are closest in time, with the first element being the closest.
Action
Search
- This field is used to filter those trainings memberships that belongs to this training.
  Required
- This field is used to filter those trainings memberships whose id match with the given.
- access_id associated to the employee, refers to employees/employees endpoint.
- This field is used to filter those trainings memberships whose employee name include some of the text written.
- This field is used to filter those memberships whose employees belongs to this team.
- This field is used to filter those trainings memberships whose attendance status is the given.
- This field is used to filter those trainings memberships whose employees belongs to this group.
Action
Search
- id
- ids
- access id
- search
- status
- catalog
- only assigned
- with expired memberships
Action
Search
- ids
- overlap period id
- schedule id
Action
Search
- List of identifiers of the overlap periods
Action
Search
- with employee ids
  Required
- with periods
  Required
- ids
Action
Search
- Calendar
- Time Before
  Required
- Time Before (Unit)
  Required
Trigger
Polling
Try It
- Shared Inbox
- Parent Folder
- Child Folder
Trigger
Polling
Try It
- Contact Folder
Trigger
Polling
Try It
- Parent Folder
- Child Folder
- Search terms
  Required
- Note
Trigger
Polling
Try It
New Flagged Email
Triggers when a new email is flagged.
Trigger
Polling
Try It
- Calendar
Trigger
Polling
Try It
- Event
- Merge with existing attendees?
- Attendees
Action
Write
- Distribution list
  Required
- User email
  Required
Action
Write
- Calendar
- Subject
  Required
- Start Date & Time
  Required
- End Date & Time
  Required
- Location Name
- Sensitivity
- Attendees
- Is this an All Day Event?
- Description
- Show me as Free or Busy
- Is this an Online Meeting?
- Enable Reminder
- Categories
Action
Write
- Shared Mailbox
- To Email(s)
  Required
- CC Email(s)
- BCC Email(s)
- Reply-To Email
- Subject
  Required
- Body Format
  Required
- Body
  Required
- Attachment
- Action for Files Larger Than 150MB
Action
Write
- Shared Mailbox
- Folder Name
  Required
- Parent Folder
Action
Write
- Shared Mailbox
- Email ID
  Required
Action
Write
- Shared Mailbox
- Email ID
  Required
- Flag Action
  Required
Action
Write
- Shared Mailbox
- Email ID
  Required
- Mark as
  Required
Action
Write
- Shared Mailbox
- Categories to Remove
  Required
- Email ID
  Required
Action
Write
- Send From (Shared Mailbox)
- Draft Email ID
  Required
Action
Write
- Shared Mailbox
- Email ID
  Required
- Importance
  Required
Action
Write
- Contact Folder
- Contact
  Required
- First Name
- Last Name
- EmailAddresses
- BusinessPhones
- HomePhones
- MobilePhone
- JobTitle
- CompanyName
- Department
- Business Website URL
- PersonalNotes
- Street
- City
- State
- Postal Code
- Country or Region
- Street
- City
- State
- Postal Code
- Country or Region
- Street
- City
- State
- Postal Code
- Country or Region
Action
Write
- Calendar
- SearchTerm
  Required
- Start Date & Time
- End Date & Time
Action
Search
- Search_info
- Search Value
  Required
Action
Search
- Group email address or ID
  Required
- Search Term
- Start Date & Time
- End Date & Time
Action
Search
- Calendar
- Start Date & Time
  Required
- End Date & Time
  Required
- Select Fields
Action
Search

- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Trigger
Instant
Try It
- identifier
  Required
Action
Write
- Name of the webhook subscription - [name]
- String to verify the subscription - [challenge]
- Company identifier of the webhook subscription - [company_id]
  Required
- Boolean to enable/disable the subscription - [enabled]
- API version of the webhook subscription that determines the schema of the payload - [api_version]
Action
Write
- identifier of the Application
  Required
Action
Write
- Application author id - [author_id]
- Application author type - [author_type]
- Application candidate phone - [phone]
- Application candidate id - [ats_candidate_id]
- Application job posting id - [ats_job_posting_id]
  Required
- Application phase id - [ats_application_phase_id]
- Whether or not the candidate has given consent to be added to the talent pool - [consent_to_talent_pool]
- Application cover letter - [cover_letter]
- Application source - [source]
- Application medium - [medium]
- Answers_one
Action
Write
- identifier of the candidate. - [id]
  Required
- email of the candidate. - [email]
- first name of the candidate. - [first_name]
- last name of the candidate. - [last_name]
- is the candidate part of talent pool? - [talent_pool]
- date when the consent was given. - [consent_given_at]
- phone number of the candidate. - [phone_number]
- personal web resource from the candidate. - [personal_url]
Action
Write
- Id of the evaluation form to be saved as a template. - [id]
  Required
Action
Write
- the ID of the feedback entry to be updated. - [id]
- the overall rating from 1 to 5 for the candidate's application. - [rating]
- the description of the feedback provided. - [description]
- the ID of the phase within the application related to the feedback. - [ats_application_phase_id]
Action
Write
- The Job ID of the job posting that you want to duplicate. - [id]
  Required
Action
Write
- [id]
  Required
- [title]
- [description]
- [contract_type]
- [workplace_type]
- [status]
- [schedule_type]
- [team_id]
- [location_id]
- [salary_format]
- [salary_from_amount_in_cents]
- [salary_to_amount_in_cents]
- [cv_requirement]
- [cover_letter_requirement]
- [phone_requirement]
- [photo_requirement]
- [salary_period]
Action
Write
- [content]
  Required
- [sent_by_id]
  Required
- [sent_by_type]
  Required
- [ats_application_id]
  Required
- [attachments]
  Required
- [topic]
  Required
- [send_as_corporate_email]
  Required
- [delayed_until]
Action
Write
- Id of the time settings break configuration - [time_settings_break_configuration_id]
  Required
- Id of the attendance employee setting - [attendance_employees_setting_id]
  Required
- Status of the break configuration if enabled or not - [enabled]
  Required
Action
Write
- [attendance_shift_id]
- [clock_in]
- [clock_out]
- [date]
- [reference_date]
- [employee_id]
  Required
- [id]
  Required
- [location_type]
- [observations]
- [reason]
- [time_settings_break_configuration_id]
Action
Write
- [id]
  Required
- [reason]
- [approver_id]
Action
Write
- [id]
  Required
- [date]
- [description]
- [hours_amount]
- [reason]
Action
Write
- [id]
  Required
- [reason]
  Required
- [approver_id]
Action
Write
- Employee id of the break - [employee_id]
- Current time of the break - [now]
  Required
- Observations of the break - [observations]
- [project_worker_id]
- [subproject_id]
Action
Write
- Employee identifier - [employee_id]
- Clock in time - [now]
  Required
- Latitude from where user clocked in - [latitude]
- Longitude from where user clocked in - [longitude]
- Location identifier - [accuracy]
- Notes on the shift record - [observations]
- Place where user has clocked in - [location_type]
- Location identifier - [workplace_id]
- Break configuration identifier - [time_settings_break_configuration_id]
- Project worker identifier - [project_worker_id]
- Subproject identifier - [subproject_id]
Action
Write
- id
  Required
Action
Write
- Id of the employee related - [employee_id]
- Date of the shift - [date]
  Required
- Reference date of the shift - [reference_date]
- number of days of the shift - [day]
- Time of the clock in - [clock_in]
- Time of the clock out - [clock_out]
- Comments added to the shift - [observations]
- Boolean that indicates if the shift is a half day - [half_day]
- Boolean that indicates if the shift is workable - [workable]
- Type of the location - [location_type]
- Source of the shift creation - [source]
- Id of the break configuration - [time_settings_break_configuration_id]
Action
Write
- incidence (aka employee update) identifier to update. - [id]
  Required
- status of the incidence (aka employee update). It can be any of 'in-preparation', 'to-do', 'doing', 'done', 'discarded' - [status]
- Boolean that indicates is the incidence (aka employee update) has message - [has_message]
- [message_from]
- Date in which the incidence (aka employee update) was read - [read_at]
- Boolean that indicate if the incidence is read - [mark_as_read]
Action
Write
- [id]
- [contracts_taxonomy_id]
  Required
- [description]
- [compensation_type]
- [amount]
- [unit]
- [sync_with_supplements]
- [payroll_policy_id]
- [recurrence_count]
- [starts_on]
- [recurrence]
- [first_payment_on]
- [calculation]
- [time_condition]
- [minimum_amount_of_hours]
- [minimum_amount_of_hours_in_cents]
Action
Write
- contract version identifier.
  Required
Action
Write
- employee identifier, refers to /employees/employees endpoint. - [employee_id]
  Required
- the day the specific contract starts, in case of hiring the same than starts_on. - [effective_on]
  Required
- the day the employee is hired. - [starts_on]
  Required
- the day the employee is terminated. - [ends_on]
- the frequency of the working hours. - [working_hours_frequency]
- the days of the week the employee works. - [working_week_days]
- the amount of hours the employee works. - [working_hours]
- the maximum amount of hours the employee can work in a year. - [max_legal_yearly_hours]
- the maximum amount of hours the employee can work in a week. - [maximum_weekly_hours]
- the frequency of the salary payment. - [salary_frequency]
- the amount of money the employee earns. - [salary_amount]
- job title of the employee. - [job_title]
- a flag that indicates if the employee has a trial period. - [has_trial_period]
- when the trial period ends. - [trial_period_ends_on]
- [copy_current_contract_version]
- [job_catalog_level_id]
Action
Write
- Company identifier where this field belongs - [company_id]
  Required
- Group of employees that can edit the field - [editable]
- Group of employees that can see the field - [visible]
- Field label - [label]
- [field_type]
  Required
- Minimum value in range field type - [min_value]
- Maximum value in range field type - [max_value]
- Requirement to fill this field - [required]
- Array of options - [options]
- [position]
Action
Write
- Schema identifier - [schema_id]
  Required
- Company identifier - [company_id]
  Required
- Resource field label - [label]
- Type of the value for the resource field - [field_type]
  Required
- Requirement to fill this resource field - [required]
  Required
- Maximum value for range field type - [max_value]
- Minimum value for range field type - [min_value]
- Field position within schema - [position]
- Group for which this field is editable - [editable]
  Required
- Group for which this field is visible - [visible]
  Required
- Array of options to choose from - [options]
Action
Write
- Custom Fields identifier - [field_id]
  Required
- Type of the object that the custom field is attached to: 'Document' | 'Employee' | 'Contracts::ContractVersion' | 'CustomResources::Value' - [valuable_type]
  Required
- Identifier of the object that the custom field is attached to - [valuable_id]
  Required
- Custom Fields value - [value]
  Required
Action
Write
- Identifier of the schema this value belongs to - [schema_id]
  Required
- [employee_id]
  Required
- Identifier of the field this value belongs to - [field_id]
  Required
- Value for schema custom field - [value]
  Required
Action
Write
- document identifiers. - [id]
  Required
- flag to indicate if the document is public. - [public]
  Required
- employee identifier associated to the document. - [employee_id]
- folder identifier, references to documents/folders endpoint. - [folder_id]
- flag to indicate if the document requires an electronic signature. - [request_esignature]
  Required
- list of user access identifiers associated to the document, refers to /employees/employees endpoint. - [signee_ids]
  Required
Action
Write
- flag to indicate if the document is public. - [public]
  Required
- document space, in case of employee_my_documents it's necessary to fill employee_id. - [space]
  Required
- folder identifier, references to documents/folders endpoint. - [folder_id]
- final name of the file, even if the file has been uploaded with a different name. - [file_filename]
- flag that indicates if the document is pending assignment. - [is_pending_assignment]
  Required
- leave identifier associated to the document, refers to /timeoff/leaves endpoint. - [leave_id]
- file to upload, the binary file. - [file]
  Required
- employee identifier associated to the document. - [employee_id]
- access identifier of the author, refers to /employees/employees endpoint. - [author_id]
  Required
- company identifier, refers to /api/me endpoint. - [company_id]
  Required
- list of user access identifiers associated to the document, refers to /employees/employees endpoint. - [signee_ids]
  Required
- flag to indicate if the document requires an electronic signature. - [request_esignature]
  Required
Action
Write
- list of document identifiers. - [ids]
Action
Write
- Company ID - [company_id]
  Required
- Folder name - [name]
  Required
- The space of the folder is related to the type of documents that will be stored in it. You should always use "employee_my_documents" - [space]
  Required
Action
Write
- id of the employee. - [id]
  Required
- access_id of the creator. - [access_id]
- gender of the employee (male | female). - [gender]
- name of the employee. - [first_name]
- last name of the employee. - [last_name]
- national identifier number. - [identifier]
- type of identifier (ex passport). - [identifier_type]
- birthday of the employee. - [birthday_on]
- nationality country code of the employee (Spain ES, United Kingdom GB). - [nationality]
- address of the employee. - [address_line_1]
- address of the employee. - [address_line_2]
- postal code of the employee. - [postal_code]
- city of the employee. - [city]
- state/province/region of the employee. - [state]
- country code of the employee (Spain ES, United Kingdom GB). - [country]
- bank account number of the employee. - [bank_number]
- code to identify banks and financial institutions globally. - [swift_bic]
- id of manager, you can get the manager_id from employees endpoint. - [manager_id]
- id of manager, you can get the manager_id from employees endpoint. - [timeoff_manager_id]
- social security number of the employee. - [social_security_number]
- does the employee have work permit? - [has_work_permit]
- phone number of the employee. - [phone_number]
- identity number or string used inside a company to internally identify the employee. - [company_identifier]
- legal entity of the employee, references to companies/legal_entities. - [legal_entity_id]
- location id of the employee, references to locations/locations. - [location_id]
- nickname of the employee or a name that defines the employee better. - [preferred_name]
- pronouns that an employee uses to define themselves. - [pronouns]
- name of the employee contact. - [contact_name]
- phone number of the employee contact . - [contact_number]
- personal email of the employee. - [personal_email]
- officially certified level of disability granted by public administration for individuals with physical or mental impairments, expressed in cents - [disability_percentage_cents]
- identifier expiration date - [identifier_expiration_date]
Action
Write
- id of the employee. - [id]
  Required
- when the employee will be terminated. - [terminated_on]
  Required
- A reason for the termination. - [termination_reason]
- id of manager that terminates the employee, you can get the manager_id from employees endpoint. - [termination_assigned_manager_id]
Action
Write
- Name of the ledger account - [name]
- Number of the ledger account - [number]
  Required
- Type of the ledger account - [type]
  Required
- Legal entity ID of the ledger account - [legal_entity_id]
- Id of the ledger account on the external system. This field is important to avoid having duplicated ledger accounts - [external_id]
Action
Write
- [id]
  Required
- [name]
- [code]
- [description]
- [company_id]
  Required
Action
Write
- [name]
  Required
- [company_id]
  Required
- [legal_entity_id]
- [code]
- [description]
Action
Write
- identifier of the location - [id]
  Required
- name of the location - [name]
- country code of the location - [country]
- whether the location is the main one - [main]
- City of the location - [city]
- State of the location - [state]
- phone number of the location - [phone_number]
- Postal code of the location - [postal_code]
- Address line 1 of the location - [address_line_one]
- Address line 2 of the location - [address_line_two]
- timezone of the location - [timezone]
- latitude of the location - [latitude]
- longitude of the location - [longitude]
- radius of the location - [radius]
- siret of the location (only for France) - [siret]
Action
Write
- [id]
  Required
Action
Write
- [name]
  Required
- [location_id]
  Required
Action
Write
- payroll employee identifier
  Required
Action
Write
- identifier of the employee - [employee_id]
  Required
- social security number of the employee - [social_security_number]
- tax id of the employee - [tax_id]
- country code of the employee pt | it | de - [country]
  Required
Action
Write
- Employee id. - [employee_id]
  Required
- Civil status of the employee. - [civil_status]
- Number of dependants of the employee. - [number_of_dependants]
Action
Write
- Code identifier - [id]
  Required
- Code Value - [code]
  Required
Action
Write
- [id]
  Required
- [status]
  Required
- [notify_employee]
  Required
- [employee_ids]
  Required
Action
Write
- The supplement id - [id]
  Required
- The employee id of the supplement - [employee_id]
- The supplement contract compensation id - [contracts_compensation_id]
- The supplement contract taxonomy id - [contracts_taxonomy_id]
- Supplement amount in cents - [amount_in_cents]
- Supplement effective on date following the format YYYY-MM-DD - [effective_on]
- Supplement unit - [unit]
- Supplement payroll policy period id - [payroll_policy_period_id]
Action
Write
- Review process ID - [process_id]
  Required
Action
Write
- [id]
  Required
- [scale_id]
  Required
Action
Write
- Review process ID - [review_process_id]
  Required
- List of access IDs to be added as owners - [owner_access_ids]
  Required
Action
Write
- Review process ID to duplicate - [id]
  Required
- Access ID to be set as author of the new review process - [author_access_id]
  Required
Action
Write
- Access identifier of the author of the review process - [author_access_id]
  Required
- Name of the review process - [name]
- A brief description of the review process - [description]
- Review types that will be assigned to the review process. It'll be used to create the evaluations when the process starts - [reviewer_strategies]
- Condition that defines the employees that will be evaluated (participants). Calculated when the review process starts - [target_strategy]
- IDs of target strategy groups selected - [arguments]
- Date when the review process should end - [ends_at]
- Whether the action plans are enabled or not. This will allow initializing and signing action plans for self and manager evaluations - [agreements_enabled]
- Whether the review process should generate employee scores or not. This will add a mandatory question at the end of "Self" and "Manager" questionnaires to evaluate the employee's performance and generate the score. - [employee_score_enabled]
- Whether the competencies assessments are enabled or not. This will allow assessing competencies for self and manager evaluations - [competencies_assessments_enabled]
- Performance cycle ID - [cycle_id]
Action
Write
- Review process ID - [id]
  Required
Action
Write
- Review process ID - [id]
  Required
- Date when the review process should start - [starts_at]
  Required
Action
Write
- Review process ID - [id]
  Required
Action
Write
- Review process ID - [id]
  Required
- Flag to enable or disable action plans in a review process - [enabled]
  Required
Action
Write
- Review process ID - [id]
  Required
- Flag to enable or disable competencies assessments in a review process - [enabled]
  Required
Action
Write
- Review process ID - [id]
  Required
- Flag to enable or disable employee scores in a review process - [enabled]
  Required
Action
Write
- Review process ID - [id]
  Required
- Date when the review process should start - [starts_at]
  Required
Action
Write
- Review process target ID - [id]
  Required
- List of access IDs to be added as peers for the participant - [peer_access_ids]
  Required
Action
Write
- Process Target ID
  Required
Action
Write
- Review process ID - [performance_review_process_id]
  Required
- Default_rating_scale_one
Action
Write
- Review process ID - [id]
- Review process ID - [performance_review_process_id]
- When enabled, employees don't have access to their results - [restrict_answers_visibility_to_reportees]
  Required
- When enabled, managers can access the results of their reports before deadline - [early_access_to_answers_for_managers]
  Required
- When enabled, peer evaluations are anonymous so employees don't know who reviewed them - [anonymous_peer_evaluation_for_target]
  Required
Action
Write
- identifier of the comment - [id]
  Required
- identifier of the post - [post_id]
  Required
- Text of the comment - [text]
  Required
Action
Write
- identifier of the group. - [id]
  Required
Action
Write
- Identifier of the group. - [id]
  Required
- title of the group. - [title]
- description of the group. - [description]
Action
Write
- identifier of the post
  Required
Action
Write
- title of the post - [title]
  Required
- description of the post - [description]
  Required
- group identifier of the post, references to posts/groups endpoint - [post_group_id]
  Required
- allow comments and reactions on the post - [allow_comments_and_reactions]
Action
Write
- [content]
  Required
- [flexible_time_record_id]
  Required
Action
Write
- id
  Required
Action
Write
- [project_worker_id]
  Required
- [date]
  Required
- [imputed_minutes]
  Required
- [subproject_id]
Action
Write
- [id]
  Required
- [employees_assignment]
  Required
Action
Write
- Id project. - [id]
  Required
- Name of the project. - [name]
  Required
- Code for the project to be identifiable and searchable. - [code]
- Start date for the project. If given must be in iso-8601 format (YYYY-MM-DD). - [start_date]
- Due date for the project. If given must be in iso-8601 format (YYYY-MM-DD). - [due_date]
Action
Write
- [id]
  Required
Action
Write
- Project id where the tasks will be duplicated - [project_id]
- Subproject id where the tasks will be duplicated - [subproject_id]
- Task ids to be duplicated - [ids]
  Required
- Set this to true if you want to exclude assignees from the duplicated tasks - [exclude_assignees]
Action
Write
- [name]
  Required
- [content]
- [starts_on]
- [follow_up]
- [due_on]
- [assignee_ids]
- [project_id]
  Required
- [subproject_id]
- [files]
- [status]
  Required
Action
Write
- The id of the project to assign the given employees. - [project_id]
  Required
- The id of the employee to be assigned to the projects. - [employee_ids]
  Required
Action
Write
- The id of the project worker to be unassigned. - [id]
  Required
Action
Write
- [name]
  Required
- [project_id]
  Required
Action
Write
- [date]
  Required
- [project_worker_id]
  Required
- [subproject_id]
Action
Write
- id
  Required
Action
Write
- [id]
  Required
- [project_worker_id]
  Required
- [subproject_id]
Action
Write
- id
  Required
Action
Write
- identifier of the file
  Required
Action
Write
- name of the task. - [name]
  Required
- description of the task - [content]
- expiration date of the task. - [due_on]
- Employees assigned to the task, assignee_id references to employee_id. - [assignee_ids]
- status of the task (todo | in_progress | done | discarded). - [status]
  Required
Action
Write
- id of the task. - [id]
  Required
- name of the task - [name]
Action
Write
- id of the task.
  Required
Action
Write
- name of the task. - [name]
  Required
- description of the task - [content]
- expiration date of the task. - [due_on]
- Employees assigned to the task, assignee_id references to employee_id. - [assignee_ids]
- status of the task (todo | in_progress | done | discarded). - [status]
  Required
Action
Write
- Membership id. - [id]
  Required
- Assign an employee as a lead for their respective team. - [lead]
Action
Write
- id of the team
  Required
Action
Write
- Name of the team. - [name]
  Required
- Description of the team - [description]
Action
Write
- [id]
  Required
- How many units multiplied by 100 do you want to add/substract. Can be positive or negative - [days_in_cents]
- Allowance Id - [timeoff_allowance_id]
- A free text field to add a description to the incidence - [description]
- When does the incidence take effect. This is related to the allowance cycle. - [effective_on]
- Which counter does the incidence affect. Can be "accrued" or "available" - [target_balance]
Action
Write
- [id]
  Required
- Allowance id sent to migrate existing incidences from the deleted allowance to the alternative allowance - [alt_allowance_id]
  Required
Action
Write
- [id]
  Required
- Only for Allowances based on worked time. It represents how many units you need to work to be granted allowance units - [accrued_denominator_in_cents]
- Only for Allowances based on worked time. It represents how many units you are given per unit of time worked - [accrued_factor_in_cents]
- Indicates how the allowance units are accrued. For example all_days means all allowance days are given on the first day of the cycle. - [available_days]
- How many units can carry over between cycles multiplied by 100 - [carry_over_units_in_cents]
- This setting flags if units taken during a bank holiday should be deducted or not from allowance. - [count_holiday_as_workable]
- Indicates if the allowance is based on working on calendar days. - [days_type]
- When does the carryover expire in months. - [expire_in_months]
- Defines duration of the allowance cycles. Can be "yearly", "monthly_flexible" or "lifetime" - [frequency]
- Base amount of holiday allowance units multiplied by 100 - [holiday_allowance_in_cents]
- An array of leave type ids associated with that allowance - [leave_type_ids]
- Maximum the allowance can reach on accrued - [maximum_amount_in_cents]
- Allowance name set by the user - [name]
- Whether the allowance allows to request more days than available. - [negative_counter_type]
- Indicates the position in the allowance when rendering them in UI - [position]
- Whether the allowance has proration enabled or not. - [proration_type]
- Whether the allowance days are prorated or not - [pto_proratio_enabled]
- Configures how leaves duration is handled. - [range_type]
- How the accrued units of the allowance are rounded. It depends if the allowance is set in hours or days. - [rounding]
- In case the allowance has tenure periods, when is this tenure applied. - [tenure_period_transition]
- Whether the allowance has tenure periods enabled or not. - [tenure_periods_enabled]
- Tenure_periods_one
- Flag to indicate if there is unlimited accrual. - [unlimited_accrued_hours]
- Flag to indicate if there is unlimited carry over. - [unlimited_carry_over]
- Boolean to flag if carryover does not expire - [unlimited_carry_over_expiration]
- Flag to indicate that the allowance has unlimited available days - [unlimited_holidays]
Action
Write
- id
  Required
Action
Write
- The company id - [company_id]
  Required
- Name of the blocked period. - [name]
  Required
- An array of leave type identifiers for which employees can not request timeoff - [leave_type_ids]
  Required
Action
Write
- Identifier of the Leave - [id]
  Required
Action
Write
- The leave id - [id]
  Required
- The employee id of the leave - [employee_id]
- The leave type id - [leave_type_id]
- The description of the leave - [description]
- The valid start date of the leave following the format YYYY-MM-DD - [start_on]
- The valid end date of the leave following the format YYYY-MM-DD - [finish_on]
- If the leave is in: [beggining_of_day, end_of_day] - [half_day]
- The start time of a leave - [start_time]
- The hours amount in cents of a leave - [hours_amount_in_cents]
Action
Write
- Identifier of the Leave - [id]
  Required
- Reason for rejecting the leave - [reason]
Action
Write
- Whether the leave type accrues over time - [accrues]
  Required
- Whether approval is required for this leave type - [approval_required]
  Required
- A unique identifier for the leave type - [identifier]
  Required
- Whether an attachment is required for this leave type - [attachment]
- The color associated with this leave type - [color]
  Required
- The name of the leave type - [name]
  Required
- Whether the leave type is visible to employees - [visibility]
- Whether the leave type is workable (can be worked on during leave) - [workable]
  Required
- Whether the leave type is payable - [payable]
- Whether the attachment is mandatory - [is_attachment_mandatory]
- Whether half-day units are enabled for this leave type - [half_days_units_enabled]
- Maximum days in cents that can be taken - [max_days_in_cents]
- Minimum days in cents that must be taken - [min_days_in_cents]
- Identifier of the company associated with this leave type - [company_id]
  Required
- Whether the leave type is editable - [editable]
- Whether endless leave is allowed - [allow_endless]
- Whether the leave type is restricted - [restricted]
- Description of the leave type - [description]
- Whether additional details are required for the leave type - [details_required]
  Required
Action
Write
- Id of the policy to update. - [id]
  Required
- The name of the policy. - [name]
- Policy description. - [description]
- If the policy is the main policy. - [main]
Action
Write
- Start date of the planning version - [effective_at]
  Required
- Type of planning tool (shift_management, work_schedules, contract_hours) - [planning_tool]
  Required
- Amount of rest days per week if applicable (in cents) - [number_of_rest_days_in_cents]
- List of employee identifiers - [employee_ids]
  Required
- Work schedule identifier to include if applicable - [schedule_id]
Action
Write
- Planning version identifier - [id]
  Required
- Start date of the planning version - [effective_at]
  Required
- Amount of rest days per week if applicable (in cents) - [number_of_rest_days_in_cents]
- Type of planning tool (shift_management, work_schedules, contract_hours) - [planning_tool]
  Required
- Work schedule identifier to include if applicable - [schedule_id]
Action
Write
- [id]
  Required
- [name]
- [paid]
- [archived]
Action
Write
- id
  Required
Action
Write
- [access_ids]
- [employee_ids]
- [session_id]
  Required
- [notify]
  Required
Action
Write
- [ids]
  Required
- [status]
  Required
Action
Write
- [id]
  Required
- [name]
  Required
- [starts_at]
- [ends_at]
- [due_date]
- [duration]
- [modality]
- [link]
- [location]
- [subsidized]
- [recurrent]
Action
Write
- [access_ids]
- [employee_ids]
- [training_id]
  Required
Action
Write
- Unique identifier for the training membership. Only used to identify the training membership to update. - [id]
  Required
- This field is used to record the date a training was completed for trainings that have an expiry date. - [training_completed_at]
Action
Write
- [ids]
  Required
- [catalog]
  Required
Action
Write
- [id]
  Required
- [name]
  Required
- [code]
- [description]
  Required
- [external_provider]
- [external]
  Required
- [category_ids]
- [competency_ids]
- [cost]
- [subsidized_cost]
- [cost_decimal]
- [subsidized_cost_decimal]
- [year]
  Required
- [valid_for]
Action
Write
- [id]
  Required
- [status]
  Required
- [notify]
  Required
Action
Write
- id
  Required
Action
Write
- [author]
  Required
- [schedule_id]
  Required
- [create_params]
  Required
Action
Write
- [name]
  Required
- [schedule_type]
  Required
Action
Write
- Identifier of the webhook subscription
- Company identifier of the webhook subscription
- Type of the webhook subscription
- List only enabled webhook subscriptions
Action
Search
- Identifier of the answers
- Identifier of the apllications
Action
Search
- Application phases identifiers
- Job posting of application phases identifiers
Action
Search
- Application ids to retrieve
- Application job posting id to retrieve
- Retrieve applications by their qualified status
- Application phase id
- Application candidates ids
- Application rejection reason ids
- Application search
- Application tag ids
Action
Search
- list of candidate identifiers.
- list of candidate emails.
- list of team identifiers, refers to teams/teams endpoint.
- list of location identifiers, refers to locations/locations endpoint.
- source of the candidate.
- is the candidate remote?
- list of job posting identifiers, refers to ats/job_postings endpoint.
- minimum average rating of the candidate.
- is the candidate active?
- is the candidate part of talent pool?
- is the candidate archived?
Action
Search
- a list of source identifiers.
Action
Search
- List of IDs of the evaluation forms to be fetched.
- List of IDs of the job postings to filter the evaluation forms by.
- If true, only the evaluation forms that are templates will be fetched.
Action
Search
- retrieve only the feedbacks that match the IDs passed in the request.
- filter feedbacks based on multiple application IDs.
- fetch feedbacks related to a specific candidate.
Action
Search
- Identifiers of the hiring stages
- Identifier of the application phase that belongs to a hiring stage
Action
Search
- identifiers of the job postings
- status of the job postings
- team identifier of the job posting
- location identifier of the job posting
- legal entity identifier of the job posting
Action
Search
- Last per conversation
  Required
- id
- ids
- ats conversation id
- ats conversation ids
Action
Search
- Rejection reasons identifiers
- Rejected application identifiers
Action
Search
- The break configuration ids to retrieve
- Ids of the time settings break configuration
- Id of the attendance employee setting
- Status of the break configuration if enabled or not
Action
Search
- filter by ids.
- filter by employee ids.
- filter by shift id.
- filter by edit timesheet request status.
- filter by edit timesheet requests that were created after or including this date.
- filter by edit timesheet requests that were created before or including this date.
Action
Search
- starts on date
  Required
- ends on date
  Required
- employee ids
Action
Search
- include approval flow
  Required
- ids
- employee ids
- start on
- end on
- status
Action
Search
- Flag to filter half day shifts
  Required
- Flag to sort by created_at asc
  Required
- filter by employee ids.
- filter by shift that starts after or including this date.
- filter by shift that ends before or including this date.
- filter by ids.
- Flag to filter shifts in workable days
- Flag to filter only the latest shift for each employee
- Flag to include breaks with time configuration
- Filter by last working shift
Action
Search
- include time range category
  Required
- include non attendable employees
  Required
- start on
- end on
- employee ids
Action
Search
- A list of incidence identifiers.
  Required
Action
Search
- identifier of the legal entity
  Required
Action
Search
- id
  Required
Action
Search
- list of contract version identifiers.
  Required
Action
Search
- list of contract type identifiers.
  Required
Action
Search
- list of contract type identifiers.
  Required
Action
Search
- list of contract type identifiers.
  Required
Action
Search
- list of contract type identifiers.
Action
Search
- ids
- legal_entity_ids
- legal_entity_id
Action
Search
- Field identifiers
- field_type
- Field label
- Custom field slug
- Company identifier where this field belongs
Action
Search
- Options identifiers
- Identifiers for the fields where the options belong to
Action
Search
- Resource field identifiers
- Custom Field identifiers
- Custom Resources Schema identifiers
Action
Search
- employee_ids
- identifiers
- ids
- instance_id
- value
- slug
- field_id
Action
Search
- Schemas identifiers
Action
Search
- Values identifiers
- Employee identifiers
Action
Search
- flag to indicate if the document is pending assignment.
  Required
- flag to indicate if the document is in the trash bin.
  Required
- flag to indicate if the document belongs to a bookkeeper.
- flag to indicate if the document doesn't have a folder.
- list of employee identifiers.
- folder identifier.
- list of document identifiers.
- leave identifier associated to the document, refers to /timeoff/leaves endpoint.
Action
Search
- Active folder.
- Employee id
- ids of the folders.
- Name of the folder.
Action
Search
- get only active employees
  Required
- get only manager employees.
  Required
- filter by employee ids.
- filter by employee access ids.
- filter by employee emails.
- filter by employee name.
- filter by legal entity id (refereces to companies/legal_entities).
- filter employees by team id (references to core/teams).
- filter employees by location id (references to locations/location).
- filter by employee names that start with the given text.
Action
Search
- filter by absence incidence ids.
Action
Search
- filter by contract change incidence ids.
Action
Search
- filter by new hire incidence ids.
Action
Search
- filter by personal change incidence ids.
Action
Search
- retrieve only the `employee updates` that matches the `ids` passed in the request.
- retrieve only the `employee updates` assigned to any `employee` specified in the request.
- retrieve only the `employee updates` assigned to any `legal entity` specified in the request.
- filter `employee updates` that have the given type. The supported types are: sick, parental, name, id, address, irpf, bank, residence, nationality, gender, hiring, custom-leave, termination, contract, workplace, manual_incidence, legal_entity
- filter `employee updates` that started **later** the given param.
- filter `employee updates` that started **before** the given param.
Action
Search
- filter by termination incidence ids.
Action
Search
- include_grouped
  Required
- include_attachments
  Required
- include_manual_drafts
  Required
- ids
- company_id
- group_ids
- by_resources
- employee_ids
- reporter_ids
- status
- creation_type
- from
- to
- search
Action
Search
- include_manual_drafts
  Required
- include_attachments
  Required
- ids
- expenses_expensable_ids
- The ids of the employees to filter by
- external_authorization_ids
- card_ids
- card_payment_ids
- The time from which to filter expenses
- The time to which to filter expenses
- dispute_ids
Action
Search
- include_manual_drafts
  Required
- include_attachments
  Required
- ids
- expenses_expensable_ids
- employee_ids
- external_authorization_ids
- card_ids
- card_payment_ids
- from
- to
- dispute_ids
Action
Search
- The IDs of the per diem to read.
- The IDs of the expensables to read per diems for.
- Whether to exclude drafts from the results.
Action
Search
- Search ledger accounts by ID
- Search ledger accounts by legal_entity_id
- Search ledger accounts by type
- Search ledger accounts by number
Action
Search
- cost_center_id
- employee_id
- active_on
- company_id
Action
Search
- id
  Required
Action
Search
- Company holiday ids
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- integration_id
  Required
- company_id
  Required
- access_id
Action
Search
- id
  Required
Action
Search
- Payroll Integration names
- Code Value
- Related object ID. Used together with codeable_type
- Related object type. Used together with codeable_id
Action
Search
- ids
  Required
Action
Search
- Filter by action plan IDs
  Required
Action
Search
- Filter by company IDs
  Required
Action
Search
- Filter by employee score scale IDs
  Required
Action
Search
- Filter by employee score IDs
  Required
Action
Search
- Filter by evaluation IDs
- Filter by review process IDs
- Only published or unpublished evaluations
- Filter by reviewer access IDs
- Only peers evaluations
- Filter by participant access IDs
- review_process_target_ids
- Exclude evaluations by IDs
Action
Search
- Filter by review process IDs
Action
Search
- Filter by review process IDs
  Required
Action
Search
- Filter by review process target IDs
- Filter by access IDs
- Only participants for peer assignment
- Only participants with no manager assigned
- Filter by reviewer process IDs
- Filter by agreement status
- Only participants with no peer evaluations
Action
Search
- Filter by review process IDs
Action
Search
- Filter by review process IDs
Action
Search
- id
  Required
Action
Search
- identifiers of the comment
  Required
Action
Search
- identifier of the group.
  Required
Action
Search
- identifiers of the post
  Required
Action
Search
- id
  Required
Action
Search
- start_date
  Required
- end_date
  Required
- project_ids
- time_format
- include_date
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- Retrieve only the projects that matches the ids provided in the request.
  Required
Action
Search
- Retrieve only the projects tasks that matches the ids passed in the request.
  Required
Action
Search
- Retrieve only the project workers that matches the ids provided in the request.
  Required
Action
Search
- id
  Required
Action
Search
- Time record ids to retrieve
  Required
Action
Search
- List of shift identifiers
  Required
Action
Search
- identifiers of the files
  Required
Action
Search
- retrieve only the tasks that match the IDs passed in the request.
  Required
Action
Search
- Membership ids.
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- An array of allowance ids to look for
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- The leave ids to retrieve
  Required
Action
Search
- Identifiers of the leave types
  Required
Action
Search
- The policies ids to retrieve.
  Required
Action
Search
- To retrieve only active planning versions
  Required
- List of employee identifiers
- For shift management
- Type of planning tool (shift_management, work_schedules, contract_hours)
- List of work schedule identifiers to include
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- This field is used to filter those sessions whose id match with the given.
  Required
Action
Search
- This field is used to filter those trainings memberships whose id match with the given.
  Required
Action
Search
- id
  Required
Action
Search
- id
  Required
Action
Search
- List of identifiers of the overlap periods
  Required
Action
Search
- id
  Required
Action
Search
Cancelled Calendar Event
Triggers when an event is cancelled.
Trigger
Instant
Try It
- Calendar
Trigger
Polling
Try It
- Parent Folder
- Child Folder
Trigger
Polling
Try It
- Shared Mailbox
  Required
- Parent Folder
- Child Folder
Trigger
Polling
Try It
- Shared Inbox
- Parent Folder
- Child Folder
Trigger
Polling
Try It
- Contact Folder
Trigger
Polling
Try It
- Email ID
  Required
- Categories
  Required
- Mark as Read
Action
Write
- Shared Mailbox
- Destination Folder
  Required
- Email ID
  Required
Action
Write
- Contact Folder
- First Name
  Required
- Last Name
- EmailAddresses
- BusinessPhones
- HomePhones
- MobilePhone
- JobTitle
- CompanyName
- Department
- Business Website URL
- FileAs
- PersonalNotes
- Street
- City
- State
- Postal Code
- Country or Region
- Street
- City
- State
- Postal Code
- Country or Region
- Street
- City
- State
- Postal Code
- Country or Region
Action
Write
- Shared Mailbox
- Email ID
  Required
- To Email(s)
- CC Email(s)
- BCC Email(s)
- Reply-To Email
- Subject
- Body Format
- Body
- Attachment
- Action for Files Larger Than 150MB
- Reply to All
Action
Write
- Contact to Delete
  Required
Action
Write
- Event
  Required
Action
Write
- Send From (Shared Mailbox)
- Email ID
  Required
- To Recipients
  Required
- Comment
Action
Write
- Email ID
  Required
- Destination Folder
  Required
Action
Write
- Email ID
  Required
- Comment
Action
Write
- Send From (Shared Mailbox)
- To Email(s)
  Required
- CC Email(s)
- BCC Email(s)
- Reply-To Email
- Subject
  Required
- Body Format
  Required
- Body
  Required
- Attachments
- Action for Files Larger Than 150MB
Action
Write
- Event
- Subject
- Start Date & Time
- End Date & Time
- All Day Event?
- Is Online Meeting?
- Hide attendees list?
- Description
- Show me as Free or Busy
- The importance of the event
- Merge with existing attendees?
- Attendees
- Categories
- Location
Action
Write
- Stop on error
  Required
- HTTP Method
  Required
- URL
  Required
- Query string parameters
- Additional request headers
- Body
Action
Write
- Contact Folder
- First Name
- Last Name
- Email
Action
Search
- Folder_info
- Folder
  Required
- Search Terms
- From Address
- Start Date
- End Date
Action
Search
- Shared Mailbox
- Email ID
  Required
- Attachment ID
  Required
Action
Search
- Contact Folder
- First Name
  Required
- Last Name
- Email
- BusinessPhones
- HomePhones
- MobilePhone
- JobTitle
- CompanyName
- Department
- Business Website URL
- FileAs
- PersonalNotes
- Street
- City
- State
- Postal Code
- Country or Region
- Street
- City
- State
- Postal Code
- Country or Region
- Street
- City
- State
- Postal Code
- Country or Region
Action
Search or write

About Factorial

Factorial is an HR platform for SMEs.

HelpHelp

Related categories

HR Talent & Recruitment

About Microsoft Outlook

Microsoft Outlook is a web-based suite of webmail, contacts, tasks, and calendaring services.

HelpHelp

Related categories

Calendar

Microsoft

Similar apps

Gmail

Email, Google

Zoho Mail

Email, Zoho

Factorial + Microsoft Outlook

Factorial + Microsoft Outlook

Invite new employees in Factorial and send emails in Microsoft Outlook

More things you can do with Factorial and Microsoft Outlook

Related Zap Templates

Related Zap Templates