PeopleForce
API integration

list_all_people_force_employees

List employees in PeopleForce (v3), filterable by status (active by default; use all to include terminated), ids, emails, employee numbers, manager, legal entity, hire date and created/updated time, with custom fields selectable via fields[]. Returns employee records with id, status, employee_number, full_name, first_name, last_name, email, hired_on, date_of_birth, gender, legal_entity, position, job_level, location, employment_type, division, department, job_profile, reporting_to, fields and termination details.

get_single_people_force_employee_by_id

Get a single PeopleForce employee (v3) by id, including department ancestors, manager, direct reports and custom fields (optionally with historical values). Returns the employee record. Required: id.

list_all_people_force_departments

List departments in PeopleForce (v3). Returns: id, name, parent_id, manager_id, department_level, fields, created_at, updated_at.

create_a_people_force_department

Create a department in peopleforce. Returns the created department object including id, name, parent_id, manager_id, created_at, updated_at, and fields (custom fields with values). Required: name.

delete_a_people_force_department_by_id

Delete a department in peopleforce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_department_by_id

Get a single peopleforce department by id. Returns: id, name, parent_id, manager_id, created_at, updated_at, fields, applicant, pipeline_state. Required: id.

update_a_people_force_department_by_id

Update a department in peopleforce by id. Returns the updated department object including id, name, parent_id, manager_id, created_at, updated_at, and fields (custom fields with values). Required: id, name.

list_all_people_force_employment_types

List employment types in PeopleForce (v3), e.g. full-time or contractor. Returns: id, name, created_at, updated_at.

list_all_people_force_locations

List office locations in PeopleForce (v3). Returns: id, name, country_code, address, time_zone, holiday_policy_id, created_at, updated_at.

create_a_people_force_location

Create a new location in peopleforce. Returns the created location object including id, name, country_code, address, time_zone, holiday_policy_id, created_at, and updated_at. Required: name.

delete_a_people_force_location_by_id

Delete a location in peopleforce by id. Returns an empty 204 response on success. Required: id.

update_a_people_force_location_by_id

Update an existing location in peopleforce by id. Returns the updated location object including id, name, country_code, address, time_zone, and holiday_policy_id. Required: name and id.

list_all_people_force_leave_requests

List leave (time-off) requests in PeopleForce (v3), filterable by employee, states, date range and created/updated time. Returns requests with id, employee_id, leave_type, state, amount, hours, tracking_time_in, starts_on, ends_on, comment, entries, leave_type_policy, approvals and the employee.

get_single_people_force_leave_request_by_id

Get a single PeopleForce leave request (v3) by id. Returns: id, employee_id, leave_type, state, amount, hours, starts_on, ends_on, comment, entries, leave_type_policy, approvals, employee. Required: id.

list_all_people_force_leave_types

List leave types in PeopleForce (v3), e.g. vacation or sick leave. Returns: id, name, unit, hex_color, fa_class, created_at.

list_all_people_force_leave_policies

List leave policies in PeopleForce (v3): the accrual rules attached to leave types. Returns: id, name, activity_type, counted_as, leave_type_id, visibility, type, created_at, updated_at.

list_all_people_force_positions

List job positions (titles) in PeopleForce (v3). Returns: id, name, created_at, updated_at.

list_all_people_force_candidates

List recruitment candidates in PeopleForce (v3), filterable by email, phone numbers, skills, vacancy ids, pipeline stage and created/updated time. Returns candidates with id, full_name, email, cover_letter, resume, created_by, applications (vacancy, pipeline_state, disqualify_reason, AI insights), skills, desired_salary and currency_code.

get_single_people_force_candidate_by_id

Get a single PeopleForce recruitment candidate (v3) by id, including applications, custom fields and consents. Returns: id, full_name, email, cover_letter, resume_url, applications, custom_fields, consent, future_recruitment_consent, desired_salary, currency_code. Required: id.

list_all_people_force_candidate_fields

List the custom candidate fields defined in PeopleForce recruitment (v3). Returns field definitions with id, name, internal_name and type.

list_all_people_force_employee_leave_balances

List the current leave balances of a PeopleForce employee (v3), one per leave type policy. Returns: id, effective_on, balance, leave_type_policy, leave_type. Required: employee_id.

list_all_people_force_employee_fields

List the employee custom field definitions in PeopleForce (v3); internal_name is the key used in each employee's fields object. Returns: id, name, internal_name, type, group, created_at, updated_at.

list_all_people_force_teams

List teams in PeopleForce (v3) with their lead and members. Returns: id, name, description, team_lead, team_members, created_at, updated_at.

list_all_people_force_divisions

List divisions in PeopleForce (v3). Returns: id, name, created_at, updated_at.

create_a_people_force_division

Create a new division in peopleforce. Returns the created division including its id, name, created_at, and updated_at. Required: name.

delete_a_people_force_division_by_id

Delete a division in peopleforce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_division_by_id

Get a single PeopleForce division by id. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: id.

update_a_people_force_division_by_id

Update a PeopleForce division by id. Returns the updated division: id, name, created_at, updated_at. Required: id, name.

list_all_people_force_pending_leave_requests

List leave requests awaiting approval in PeopleForce (v3). Returns the same fields as leave-requests.list for requests in the pending state.

list_all_people_force_employee_salaries

List the salary history of a PeopleForce employee (v3); requires compensation access on the API key (403 otherwise). Returns: id, effective_on, amount, currency_code, per, overtime, comment, pay_schedule, created_at, updated_at. Required: employee_id.

list_all_people_force_employee_positions

List the position history of a PeopleForce employee (v3): each effective-dated record with position, department, division, location, job_level, legal_entity and reporting_to. Required: employee_id.

create_a_people_force_public_asset_assignment

Create an asset assignment in PeopleForce, issuing an asset to a user. Returns the created assignment including id, user_id, asset_id, issued_on, returned_on, created_at, and updated_at. Required: asset_id, user_id, issued_on.

delete_a_people_force_public_asset_assignment_by_id

Delete an asset assignment in PeopleForce by id. Returns an empty 204 response on success.

update_a_people_force_public_asset_assignment_by_id

Update an asset assignment in PeopleForce by marking the asset as returned. Returns the updated assignment including id, user_id, asset_id, issued_on, returned_on, created_at, and updated_at. Required: id, returned_on.

create_a_people_force_public_asset_assignments_v_2

Create a PeopleForce asset assignment that issues an asset to an employee. Returns the created assignment including id, user_id, asset_id, issued_on, returned_on, created_at, and updated_at. Required: asset_id, user_id, issued_on.

delete_a_people_force_public_asset_assignments_v_2_by_id

Delete a PeopleForce asset assignment by id; the assignment is soft-deleted. Returns an empty 204 response on success. Required: id.

update_a_people_force_public_asset_assignments_v_2_by_id

Update an asset assignment in peopleforce by its id, e.g. to record the asset's return. Returns: id, user_id, asset_id, issued_on, returned_on, created_at, updated_at, applicant, pipeline_state. Required: id, returned_on.

create_a_people_force_public_asset_assignments_v_3

Create an asset assignment in PeopleForce, issuing a company asset to an employee on a given date. Returns the created assignment: id, asset_id, user_id, issued_on, returned_on, created_at, updated_at. Requires asset_id, user_id, and issued_on.

delete_a_people_force_public_asset_assignments_v_3_by_id

Delete an asset assignment in PeopleForce by id (the assignment is soft-deleted). Returns an empty 204 response on success. Required: id.

update_a_people_force_public_asset_assignments_v_3_by_id

Update an asset assignment in PeopleForce by id, recording the date the asset was returned. Returns the updated assignment: id, asset_id, user_id, issued_on, returned_on, created_at, updated_at. Requires id and returned_on.

create_a_people_force_public_asset_category

Create an asset category in PeopleForce. Returns the created category with id, name, icon, created_at, and updated_at. Required: name, icon.

delete_a_people_force_public_asset_category_by_id

Delete an asset category in PeopleForce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_asset_categories

List all asset categories in PeopleForce. Returns each category with id, name, icon, created_at, and updated_at.

update_a_people_force_public_asset_category_by_id

Update an asset category in PeopleForce by id. Returns the updated category with id, name, icon, created_at, and updated_at. Required: id, name.

create_a_people_force_public_asset_categories_v_2

Create an asset category in Peopleforce. Returns the created category including id, name, icon, created_at, and updated_at. Requires name and icon.

list_all_people_force_public_asset_categories_v_2

List all asset categories in Peopleforce. Returns each category with id, name, icon, created_at, and updated_at.

create_a_people_force_public_asset_categories_v_3

Create an asset category in Peopleforce. Returns the created category's id, name, icon, created_at, and updated_at. Requires name and icon.

list_all_people_force_public_asset_categories_v_3

List asset categories in Peopleforce. Returns each category's id, name, icon, created_at, and updated_at.

create_a_people_force_public_asset

Create an asset in Peopleforce. Returns the created asset object including id, name, code, serial_number, price, currency_code, asset_category_id, and asset_assignments. Requires name, code, and asset_category_id.

delete_a_people_force_public_asset_by_id

Delete an asset in Peopleforce by id. Deleting an asset cascades the discard to its existing asset_assignments. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_asset_by_id

Get an asset in Peopleforce by id. Returns the asset with its custom fields, including id, name, code, serial_number, price, currency_code, location_id, asset_assignments, and custom_fields. Required: id.

list_all_people_force_public_assets

List all assets in Peopleforce, returned in stable order by id. Returns asset records including id, name, code, serial_number, price, currency_code, asset_category_id, and asset_assignments.

update_a_people_force_public_asset_by_id

Update an asset in Peopleforce by id. Returns the updated asset with its custom fields, including id, name, code, serial_number, price, currency_code, location_id, asset_assignments, and custom_fields. Requires id and name.

create_a_people_force_public_assets_v_2

Create an asset in PeopleForce. Returns the created asset record including its id, name, code, serial_number, price, asset_category_id, and asset_assignments. Requires name, code, and asset_category_id.

delete_a_people_force_public_assets_v_2_by_id

Delete an asset in PeopleForce by id. Deleting an asset cascades the discard to its existing asset assignments. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_assets_v_2_by_id

Get a single asset in PeopleForce by id. Returns the full asset record including id, name, code, serial_number, description, price, currency_code, location_id, asset_category_id, created_at, updated_at, and asset_assignments. Required: id.

list_all_people_force_public_assets_v_2

List all assets in PeopleForce. Returns each asset record with its id, name, code, serial_number, description, price, currency_code, location_id, asset_category_id, created_at, updated_at, and asset_assignments.

update_a_people_force_public_assets_v_2_by_id

Update an asset in PeopleForce by id. Returns the updated asset record including id, name, code, serial_number, price, currency_code, asset_category_id, and asset_assignments. Requires name. Required: id.

create_a_people_force_public_assets_v_3

Create an asset in PeopleForce. Returns the created asset including id, name, code, serial_number, price, currency_code, asset_category_id, and asset_assignments (warranty expiry is exposed under the upstream key `warranity_expires_on`). Requires name, code, and asset_category_id.

delete_a_people_force_public_assets_v_3_by_id

Delete an asset in PeopleForce by id. Deleting an asset cascades the discard to its existing asset assignments. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_assets_v_3_by_id

Get a single asset in PeopleForce by id. Returns the asset including id, name, code, serial_number, description, price, currency_code, location_id, asset_category_id, and asset_assignments. Required: id.

list_all_people_force_public_assets_v_3

List assets in PeopleForce. Returns assets including id, name, code, serial_number, price, currency_code, asset_category_id, created_at, and updated_at. Results are paginated.

update_a_people_force_public_assets_v_3_by_id

Update an asset in PeopleForce by id. Returns the updated asset including id, name, code, serial_number, price, currency_code, location_id, asset_category_id, and asset_assignments (warranty expiry is exposed under the upstream key `warranity_expires_on`). Requires id and name.

list_all_people_force_public_calendars

List company calendar events in peopleforce. Returns an array of calendar events including type, title, starts_on, ends_on, and a data object with the employee's user_id, first_name, and last_name.

list_all_people_force_public_calendars_v_2

List all calendars in peopleforce. Returns calendar events with type, title, starts_on, ends_on, and a data object containing user_id, first_name, and last_name.

list_all_people_force_public_calendars_v_3

List Peopleforce calendar events. Returns each event's type, title, starts_on, ends_on, and data (user_id, first_name, last_name). Optional: starts_on, ends_on to narrow the returned window.

create_a_people_force_public_compensation_type

Create a compensation type in Peopleforce. Returns the created record with: id, name. Required: name.

delete_a_people_force_public_compensation_type_by_id

Delete a compensation type in Peopleforce by id. Returns an empty 204 response on success. The type is discarded rather than permanently removed. Required: id.

list_all_people_force_public_compensation_types

List compensation types in Peopleforce. Returns compensation type records with: id, name.

update_a_people_force_public_compensation_type_by_id

Update a compensation type in Peopleforce by id. Returns the updated record with: id, name. Required: id, name.

list_all_people_force_public_compensation_types_v_2

List all compensation types in PeopleForce. Returns each compensation type with its id and name.

list_all_people_force_public_compensation_types_v_3

List all compensation types in PeopleForce. Returns: id, name, applicant, pipeline_state, created_at, updated_at.

create_a_people_force_public_department

Create a department in peopleforce. Returns the created department including its id, name, parent_id, manager_id, fields, and ancestors. Required: name.

delete_a_people_force_public_department_by_id

Delete a department in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_departments

List all departments in peopleforce. Returns each department's id, name, parent_id, manager_id, department_level, fields, created_at, and updated_at.

update_a_people_force_public_department_by_id

Update a department in peopleforce by id, e.g. to rename it. Returns the updated department including its id, name, parent_id, manager_id, fields, and ancestors. Required: id, name.

create_a_people_force_public_departments_v_2

Create a department in Peopleforce. Returns the created department including its id, name, parent_id, manager_id, fields, and ancestors. Required: name.

delete_a_people_force_public_departments_v_2_by_id

Delete a department in Peopleforce by id. The department record is soft-deleted (kept in the database). Returns an empty 204 response on success. Required: id.

list_all_people_force_public_departments_v_2

List all departments in Peopleforce. Returns each department with its id, name, parent_id, manager_id, fields, and ancestors.

update_a_people_force_public_departments_v_2_by_id

Update a department in Peopleforce by id. Returns the updated department including its id, name, parent_id, manager_id, fields, and ancestors. Required: id, name.

create_a_people_force_public_departments_v_3

Create a department in Peopleforce. Returns the created department including its id, name, parent_id, fields, and ancestors. Required: name.

delete_a_people_force_public_departments_v_3_by_id

Delete a department in Peopleforce by id. Returns an empty 204 response on success. Required: id.

update_a_people_force_public_departments_v_3_by_id

Update a department in Peopleforce by id. Returns the updated department including its id, name, parent_id, fields, and ancestors. Required: id, name.

create_a_people_force_employee_additional_compensation

Create an additional compensation for an employee in PeopleForce. Returns: id, type, description, amount, currency_code, starts_on, created_at, updated_at, compensation_type, frequency, ends_on, custom_fields, applicant, pipeline_state. Required: employee_id, compensation_type_id, starts_on, amount, currency_code.

delete_a_people_force_employee_additional_compensation_by_id

Delete an additional compensation for an employee in PeopleForce by id (soft delete). Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_additional_compensations

List an employee's additional compensation records in Peopleforce. Returns: id, type, description, amount, currency_code, starts_on, created_at, updated_at, compensation_type, applicant, pipeline_state. Required: employee_id.

create_a_people_force_employee_additional_compensations_employee

Create an additional compensation for a PeopleForce employee. Returns the created compensation record including id, type, description, amount, currency_code, starts_on, compensation_type, frequency, and ends_on. Required: employee_id, compensation_type_id, starts_on, ends_on, amount, currency_code, type, frequency, description.

list_all_employee_additional_compensations_employees

List additional compensations for a PeopleForce employee. Returns records including id, type, description, amount, currency_code, starts_on, compensation_type, frequency, and ends_on. Required: employee_id.

delete_employee_additional_compensations_employee_by_id

Delete an additional compensation for a PeopleForce employee by id. Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employees_terminateds

List terminated employees in PeopleForce, filterable by termination effective date range. Returns: id, active, access, employee_number, full_name, first_name, middle_name, last_name, email, personal_email, mobile_number, work_phone_number, date_of_birth, gender, gender_id, avatar_url, probation_ends_on, hired_on, slack_username, twitter_username, facebook_url, linkedin_url,…

list_all_people_force_employees_terminateds_terminated

List terminated employees in Peopleforce. Returns terminated employee records including id, employee_number, full_name, email, hired_on, position, department, and termination details.

create_a_people_force_public_division

Create a division in Peopleforce. Returns the created division including id, name, created_at, and updated_at. Required: name.

delete_a_people_force_public_division_by_id

Delete a Peopleforce division by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_divisions

List all divisions in Peopleforce. Returns each division with id, name, created_at, and updated_at.

update_a_people_force_public_division_by_id

Update a division in Peopleforce by id. Returns the renamed division with id, name, created_at, and updated_at. Required: id and name.

create_a_people_force_public_divisions_v_2

Create a new division in peopleforce. Returns the created division including its id, name, created_at, and updated_at. Required: name.

delete_a_people_force_public_divisions_v_2_by_id

Delete a division in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_divisions_v_2

List all divisions in Peopleforce. Returns each division's id, name, created_at, and updated_at.

update_a_people_force_public_divisions_v_2_by_id

Update a division in Peopleforce by id. Returns the updated division record with id, name, created_at, and updated_at. Required: id, name.

create_a_people_force_public_divisions_v_3

Create a new division in peopleforce. Returns the created division: id, name, created_at, updated_at. Required: name.

delete_a_people_force_public_divisions_v_3_by_id

Delete a division in peopleforce by id. Returns an empty 204 response on success.

update_a_people_force_public_divisions_v_3_by_id

Update a division in peopleforce by id. Returns the updated division: id, name, created_at, updated_at. Required: id, name.

create_a_people_force_public_document_folder

Create a document folder in peopleforce. Returns the created folder: id, name, description, created_at, updated_at. Required: name.

delete_a_people_force_public_document_folder_by_id

Delete a document folder in peopleforce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_document_folder_by_id

Get a single document folder in peopleforce by id. Returns the folder with: id, name, description, created_at, updated_at. Required: id.

list_all_people_force_public_document_folders

List document folders in peopleforce. Returns each folder with: id, name, description, created_at, updated_at.

update_a_people_force_public_document_folder_by_id

Update a document folder in peopleforce by id. Returns the updated folder: id, name, description, created_at, updated_at. Required: id, name.

create_a_people_force_public_document_folders_v_2

Create a document folder in PeopleForce. Returns the created folder's id, name, description, created_at, and updated_at. Required: name.

delete_a_people_force_public_document_folders_v_2_by_id

Delete a document folder in PeopleForce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_document_folders_v_2_by_id

Get a single document folder in PeopleForce by id. Returns the folder's id, name, description, created_at, and updated_at. Required: id.

list_all_people_force_public_document_folders_v_2

List all document folders in PeopleForce. Returns folders with their id, name, description, created_at, and updated_at.

update_a_people_force_public_document_folders_v_2_by_id

Update a document folder in PeopleForce by id. Returns the updated folder's id, name, description, created_at, and updated_at. Required: id, name.

create_a_people_force_public_document_folders_v_3

Create a document folder in peopleforce, optionally nesting it under a parent folder via parent_id. Returns: id, name, description, created_at, updated_at, applicant, pipeline_state. Required: name.

delete_a_people_force_public_document_folders_v_3_by_id

Delete a document folder in peopleforce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_document_folders_v_3_by_id

Get a document folder in peopleforce by id. Returns: id, name, description, created_at, updated_at, applicant, pipeline_state. Required: id.

list_all_people_force_public_document_folders_v_3

List the tenant's document folders in peopleforce. Returns each folder's: id, name, description, created_at, updated_at.

update_a_people_force_public_document_folders_v_3_by_id

Update a document folder in peopleforce by id. Returns: id, name, description, created_at, updated_at, applicant, pipeline_state. Required: id, name.

list_all_people_force_public_employee_fields

List all custom employee fields configured in your Peopleforce tenant. Returns: internal_name, uuid, name, group, id, applicant, pipeline_state, created_at, updated_at.

list_all_people_force_public_employee_fields_v_2

List all employee fields (custom field definitions) configured in PeopleForce. Returns: id, name, internal_name, type, group, created_at, updated_at, applicant, pipeline_state. Requires no parameters.

people_force_public_employees_activate

Activate an employee in Peopleforce by employee_id. Returns the reactivated employee record including id, employee_number, full_name, email, active, hired_on, and custom_fields. Required: employee_id.

people_force_public_employees_bulk_update

Bulk update employees in Peopleforce by sending an array of update rows (each with id plus the fields to change). Returns one result row per update including id, status, employee_number, full_name, email, and fields. Required: data.

create_a_people_force_public_employee

Create an employee in Peopleforce. Returns the created employee record including id, employee_number, full_name, email, hired_on, active, and custom_fields. Requires first_name, last_name, email, and hired_on.

get_single_people_force_public_employee_by_id

Get an employee in Peopleforce by id. Returns the employee record including id, employee_number, full_name, email, hired_on, position, and custom_fields. Required: id.

list_all_people_force_public_employees

List all employees in Peopleforce. Returns each employee with id, employee_number, full_name, email, hired_on, location, and custom_fields. Filter by created_at, updated_at, hired_on, emails, and status.

update_a_people_force_public_employee_by_id

Update an employee in peopleforce by id. Returns the updated employee record including id, first_name, last_name, email, employee_number, department, and custom_fields. Required: id, first_name, last_name.

create_a_people_force_public_employees_activate

Activate (reactivate) a PeopleForce employee by employee_id. Returns the activated employee object with id, active, access, employee_number, full_name, email, hired_on, position, and department. Required: employee_id.

create_a_people_force_public_employees_v_2

Create an employee in PeopleForce. Returns the created employee record including its id, attributes (first_name, last_name, email, employee_number, hired_on), reporting_to, employment_type, position, department, and custom_fields.

get_single_people_force_public_employees_v_2_by_id

Get a single PeopleForce employee by id. Returns the employee record including its id, attributes (first_name, last_name, email, employee_number, hired_on), reporting_to, employment_type, position, department, and custom_fields. Required: id.

list_all_people_force_public_employees_v_2

List all PeopleForce employees. Returns each employee's id, attributes (employee_number, first_name, last_name, email, hired_on, date_of_birth), reporting_to, position, department, division, employment_type, custom_fields, and meta timestamps. No required parameters.

update_a_people_force_public_employees_v_2_by_id

Update a PeopleForce employee by id. Returns the updated employee record including id, attributes (employee_number, first_name, last_name, email, hired_on), reporting_to, position, department, division, employment_type, custom_fields, and meta timestamps. Required: id.

create_a_people_force_public_employees_v_3

Create an employee in PeopleForce. Returns the created employee record including its id, attributes (employee_number, first_name, last_name, email, hired_on), reporting_to, position, department, division, employment_type, location, and meta with created_at/updated_at timestamps.

update_a_people_force_public_employees_v_3_by_id

Update an employee in PeopleForce by id. Returns the updated employee record including its id, attributes (employee_number, first_name, last_name, email, hired_on), reporting_to, position, department, division, employment_type, location, and meta with created_at/updated_at timestamps. Required: id.

list_all_people_force_employee_assets

List the assets assigned to a PeopleForce employee. Returns: id, name, applicant, pipeline_state, created_at, updated_at. Required: employee_id.

list_all_people_force_employee_assets_employees

List the assets assigned to a specific peopleforce employee. Returns asset records including: id, name. Required: employee_id.

list_all_people_force_employee_certifications

List certifications recorded for a PeopleForce employee. Returns certification records including id, name, issuer, issued_on, expires_on, created_at, and updated_at. Required: employee_id.

list_all_people_force_employee_certifications_employees

List a PeopleForce employee's certifications by employee id. Returns each certification's id, name, issuer, issued_on, url, expires, expires_on, created_at, and updated_at. Required: employee_id.

create_a_people_force_employee_compensation

Create a compensation for a Peopleforce employee. Returns the created compensation with id, effective_on, amount, currency_code, per, overtime, comment, created_at, and updated_at. Required: employee_id, effective_on, amount, currency_code, per, overtime, comment.

delete_a_people_force_employee_compensation_by_id

Delete a compensation record from a Peopleforce employee. Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_compensations

List compensation records for a Peopleforce employee. Returns each compensation with id, effective_on, amount, currency_code, per, overtime, comment, created_at, and updated_at. Required: employee_id.

update_a_people_force_employee_compensation_by_id

Update a compensation record for a Peopleforce employee. Returns the updated compensation with id, effective_on, amount, currency_code, per, overtime, comment, created_at, and updated_at. Required: employee_id, id, effective_on, amount, currency_code, per, comment.

list_all_people_force_employee_compensations_employees

List PeopleForce employee compensations for a given employee. Returns each compensation record's id, effective_on, amount, currency_code, per, overtime, comment, pay_schedule, created_at, and updated_at. Required: employee_id.

create_a_people_force_employee_document

Create an employee document in Peopleforce for a specific employee by uploading a file (document) or linking an external URL (url); supply at least one of the two. Returns the created document with id, name, type, url, expires_at, document_folder, and created_at. Required: employee_id, name, document_folder_id.

delete_a_people_force_employee_document_by_id

Delete an employee document from a Peopleforce employee by id. Returns an empty 204 response on success. Required: employee_id, id.

get_single_people_force_employee_document_by_id

Get a single employee document by id for a Peopleforce employee. Returns the document with id, name, type, url, expires_at, document_folder, external_signature_id, and created_at. Required: employee_id, id (the document id from the list response).

list_all_people_force_employee_documents

List a Peopleforce employee's documents. Returns each document with id, name, type, url, document_folder, created_at, and updated_at. Required: employee_id.

create_a_people_force_employee_documents_employee

Create an employee document in peopleforce under the given employee by uploading a file or linking a URL into a document folder. Returns the created document including id, name, type, url, expires_at, its document_folder, and created_at/updated_at timestamps. Required: employee_id, name, document_folder_id.

delete_a_people_force_employee_documents_employee_by_id

Delete an employee document in peopleforce by id under the given employee. Returns an empty 204 response on success. Required: employee_id, id.

get_single_people_force_employee_documents_employee_by_id

Get a single PeopleForce employee document by id. Returns: id, name, type, url, expires_at, document_folder, external_signature_id, external_signature_document_id, created_at, updated_at, applicant, pipeline_state. Required: employee_id and id.

list_all_people_force_employee_documents_employees

List the documents of a PeopleForce employee, including expiring file download URLs. Returns: id, name, type, url, expires_at, document_folder, external_signature_id, external_signature_document_id, created_at, updated_at, applicant, pipeline_state. Required: employee_id.

list_all_people_force_employee_educations

List the education records of a PeopleForce employee. Returns: id, created_at, updated_at, applicant, pipeline_state. Required: employee_id.

list_all_people_force_employee_educations_employees

List the education records of a specific PeopleForce employee. Returns: id, created_at, updated_at, applicant, pipeline_state. Required: employee_id.

create_a_people_force_employee_employment_status

Create an employment status for a Peopleforce employee. Returns the created record: id, effective_on, employment_type, probation_policy, working_pattern, comment, created_at, updated_at. Requires employee_id, effective_from, and comment.

delete_a_people_force_employee_employment_status_by_id

Delete an employee employment status in Peopleforce by id. Returns an empty 204 response on success. Requires employee_id and id.

list_all_people_force_employee_employment_statuses

List a Peopleforce employee's employment statuses. Returns records with: id, effective_on, employment_type, probation_policy, working_pattern, comment, created_at, updated_at. Requires employee_id.

update_a_people_force_employee_employment_status_by_id

Update an employee employment status in Peopleforce by id. Returns the updated record: id, effective_on, employment_type, probation_policy, working_pattern, comment, created_at, updated_at. Requires employee_id, id, effective_from, and comment.

create_a_people_force_employee_employment_statuses_employee

Create an employment status record for a PeopleForce employee. Returns: id, effective_on, employment_type, probation_policy, working_pattern, comment, created_at, updated_at, applicant, pipeline_state. Required: employee_id, effective_from, comment.

delete_employee_employment_statuses_employee_by_id

Delete a PeopleForce employee's employment status record by id. Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_employment_statuses_employees

List a PeopleForce employee's employment status records, one record per status change in their history. Returns: id, effective_on, employment_type, probation_policy, working_pattern, comment, created_at, updated_at, applicant, pipeline_state. Required: employee_id.

update_employee_employment_statuses_employee_by_id

Update a PeopleForce employee's employment status record by id. Returns: id, effective_on, employment_type, probation_policy, working_pattern, comment, created_at, updated_at, applicant, pipeline_state. Required: employee_id, id, effective_from, comment.

create_a_people_force_employee_leave_type

Assign a leave policy to an employee in PeopleForce. Returns the created employee leave type assignment including its id, effective_on, balance, leave_type, and leave_type_policy. Required: employee_id, leave_type_id, leave_type_policy_id, effective_on.

delete_a_people_force_employee_leave_type_by_id

Delete an employee leave type by id in PeopleForce. Returns an empty 204 response on success. Required: employee_id and id.

list_all_people_force_employee_leave_types

List the leave type assignments for an employee in PeopleForce. Returns each assignment with id, effective_on, balance, leave_type, and leave_type_policy. Required: employee_id.

create_a_people_force_employee_leave_types_employee

Assign a leave type policy to an employee in peopleforce. Returns the created employee leave type including its id, effective_on, balance, leave_type, and leave_type_policy. Required: employee_id, leave_type_id, leave_type_policy_id, effective_on.

delete_a_people_force_employee_leave_types_employee_by_id

Delete an employee leave type in peopleforce (soft-deletes the assignment). Required: employee_id and id. Returns an empty 204 response on success.

list_all_people_force_employee_leave_types_employees

List an employee's leave type assignments in peopleforce. Returns each record's id, effective_on, balance, leave_type, and leave_type_policy. Required: employee_id.

create_a_people_force_employee_position

Create an employee position for a peopleforce employee. Returns the created position record including id, effective_on, position, location, division, department, reporting_to, fields, created_at, and updated_at. Required: employee_id, position_id, effective_from.

delete_a_people_force_employee_position_by_id

Delete an employee position by id (soft delete) for a peopleforce employee. Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_positions

List positions for a peopleforce employee. Returns position records including id, effective_on, position, location, division, department, reporting_to, fields, created_at, and updated_at. Required: employee_id.

update_a_people_force_employee_position_by_id

Update an employee position by id for a peopleforce employee. Returns the updated position record including id, effective_on, position, location, department, reporting_to, fields, created_at, and updated_at. Required: employee_id, id, position_id.

create_a_people_force_employee_positions_employee

Create a new employee position record for a PeopleForce employee. Returns the created record including id, effective_on, position, department, division, location, reporting_to, and fields. Required: employee_id, position_id, location_id, division_id, department_id, reporting_to_id, effective_from.

delete_a_people_force_employee_positions_employee_by_id

Delete an employee position record for a PeopleForce employee. Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_positions_employees

List employee position records for a PeopleForce employee. Returns records including id, effective_on, position, department, division, location, reporting_to, and fields. Required: employee_id.

update_a_people_force_employee_positions_employee_by_id

Update a PeopleForce employee's position record by id. Returns the updated record including id, effective_on, position, department, division, location, reporting_to, and fields. Required: employee_id, id, position_id, effective_from.

create_a_people_force_employee_salary

Create a salary for a peopleforce employee. Returns the created salary including id, effective_on, amount, currency_code, per, overtime, and pay_schedule. Required: employee_id, effective_on, amount, currency_code, per, overtime, comment.

delete_a_people_force_employee_salary_by_id

Delete an employee salary in peopleforce by id. Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_salaries

List a peopleforce employee's salaries. Returns each salary with id, effective_on, amount, currency_code, per, overtime, comment, and pay_schedule. Required: employee_id.

update_a_people_force_employee_salary_by_id

Update an employee salary in peopleforce by id. Returns the updated salary including id, effective_on, amount, currency_code, per, overtime, and pay_schedule. Required: employee_id, id, effective_on, amount, currency_code, per, comment.

create_a_people_force_employee_salaries_employee

Create a salary record for an employee in PeopleForce. Returns: id, effective_on, amount, currency_code, per, comment, created_at, updated_at, applicant, pipeline_state. Required: employee_id, effective_on, amount, currency_code, per, and comment.

delete_a_people_force_employee_salaries_employee_by_id

Delete an employee salary record in PeopleForce by id. Returns an empty 204 response on success. Required: id and employee_id.

list_all_people_force_employee_salaries_employees

List all salary records for a PeopleForce employee. Returns salary records with id, effective_on, amount, currency_code, per, overtime, comment, created_at, and pay_schedule. Required: employee_id.

update_a_people_force_employee_salaries_employee_by_id

Update a salary record for a PeopleForce employee. Returns the updated salary with id, effective_on, amount, currency_code, per, comment, and created_at/updated_at timestamps. Required: id, employee_id, effective_on, amount, currency_code, per, and comment.

list_all_people_force_employee_dependents

List the dependents of a specific employee in Peopleforce. Returns each dependent's id, full_name, date_of_birth, and gender (nullable). Required: employee_id.

list_all_people_force_employee_dependents_employees

List the dependents of a Peopleforce employee. Returns each dependent with id, full_name, date_of_birth, and gender. Required: employee_id.

list_all_people_force_employee_emergency_contacts

List a Peopleforce employee's emergency contacts. Returns each contact's name, relationship, mobile_phone_number, work/home phone numbers, and address. Required: employee_id.

list_all_people_force_employee_emergency_contacts_employees

List a PeopleForce employee's emergency contacts by employee id. Returns for each contact: name, relationship, work_phone_number, home_phone_number, mobile_phone_number, and address. Required: employee_id.

list_all_people_force_employee_holidays

List holidays for a Peopleforce employee. Returns each holiday with id, name, occurs_on, starts_on, ends_on, working, compensated_on, observed_on, holiday_policy_id, created_at, and updated_at. Required: employee_id.

list_all_people_force_employee_holidays_employees

List PeopleForce holidays that apply to a specific employee. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: employee_id.

list_all_people_force_employee_leave_balances

List a PeopleForce employee's leave balances. Returns each balance with id, effective_on, balance, leave_type_policy, and leave_type (including name, unit, and hex_color). Required: employee_id.

list_all_people_force_employee_leave_balances_employees

List leave balances for a specific employee in peopleforce. Returns each balance with id, effective_on, balance, and the associated leave_type and leave_type_policy. Required: employee_id.

create_a_people_force_employee_note

Create a note on an employee's record in Peopleforce. Returns the created note including its id, body text, created_at, updated_at, and the created_by author with id, first_name, last_name, and email. Requires employee_id and body.

list_all_people_force_employee_notes

List all notes attached to an employee's record in Peopleforce. Returns each note with its id, body content (name, text, record_type, record_id), created_at, and updated_at. Required: employee_id.

create_a_people_force_employee_notes_employee

Create a note on an employee's record in Peopleforce. Returns the created note including its id, body, created_at, updated_at, and the created_by author (id, first_name, last_name, email). Requires employee_id, body, and created_by_id.

list_all_people_force_employee_notes_employees

List an employee's notes in Peopleforce. Returns each note with its id, body, created_at, updated_at, and created_by author details. Required: employee_id.

list_all_people_force_employee_tasks

List the tasks assigned to a PeopleForce employee. Returns each task with id, type, title, starts_on, completed, assigned_to, created_at, and updated_at. Required: employee_id.

list_all_people_force_employee_tasks_employees

List PeopleForce tasks assigned to a specific employee. Returns each task's id, title, type, starts_on and ends_on dates, completion status, description, assignee, and created_at/updated_at timestamps. Required: employee_id.

create_a_people_force_employee_terminate

Terminate an employee in peopleforce, scheduling the termination effective from the given date. Returns the terminated employee record including id, employee_number, full_name, active, email, and hired_on. Required: employee_id, effective_from, termination_type_id, termination_reason_id, eligible_for_rehire, comment.

create_a_people_force_employee_terminates_terminate

Terminate an employee in Peopleforce, scheduling the termination to take effect from the given date. Returns the employee record including id, employee_number, full_name, hired_on, active, and custom_fields. Required: employee_id, effective_from, termination_type_id, termination_reason_id, eligible_for_rehire, comment.

people_force_employee_update_leave_balances_bulk_update

Update an employee's leave balance in PeopleForce for the employee identified by employee_id. Returns the updated employee record including id, full_name, email, hired_on, and custom_fields. Requires employee_id, leave_type_id, and balance.

employee_update_leave_balances_update_leave_balance_bulk_update

Update a PeopleForce employee's leave balance for a specific leave type by overwriting it with the provided value. Returns the full employee record including id, employee_number, full_name, hired_on, position, department, and custom_fields; a leave history entry is recorded when the balance differs. Required: employee_id, leave_type_id, and balance.

create_a_people_force_public_employment_type

Create a peopleforce employment type. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: name.

delete_a_people_force_public_employment_type_by_id

Delete a peopleforce employment type by id. Returns an empty 204 response on success.

list_all_people_force_public_employment_types

List all peopleforce employment types. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

update_a_people_force_public_employment_type_by_id

Rename a peopleforce employment type by id. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: id, name.

create_a_people_force_public_employment_types_v_2

Create an employment type in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: name.

delete_a_people_force_public_employment_types_v_2_by_id

Delete an employment type in Peopleforce by id. The record is kept in the database (soft delete). Returns an empty 204 response on success. Required: id.

list_all_people_force_public_employment_types_v_2

List all employment types in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

update_a_people_force_public_employment_types_v_2_by_id

Update an employment type in Peopleforce by id. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: id, name.

create_a_people_force_public_employment_types_v_3

Create an employment type in peopleforce by submitting its name. Returns the created employment type including id, name, created_at, and updated_at. Requires name.

delete_a_people_force_public_employment_types_v_3_by_id

Delete an employment type in peopleforce by id. Returns an empty 204 response on success. Required: id.

update_a_people_force_public_employment_types_v_3_by_id

Update an employment type in PeopleForce by id. Returns the updated employment type including its id, name, created_at, and updated_at. Required: id, name.

create_a_people_force_public_holiday_policy

Create a holiday policy in Peopleforce. Returns the created policy including its id, name, country_code, created_at, and updated_at. Required: name, country_code.

delete_a_people_force_public_holiday_policy_by_id

Delete a holiday policy in Peopleforce by id; dependent holidays are cascade-destroyed. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_holiday_policy_by_id

Get a single holiday policy in Peopleforce by id. Returns the policy including its id, name, country_code, created_at, and updated_at. Required: id.

list_all_people_force_public_holiday_policies

List all holiday policies in Peopleforce. Returns each policy's id, name, country_code, created_at, and updated_at.

update_a_people_force_public_holiday_policy_by_id

Update a holiday policy in Peopleforce by id (renames the policy). Returns the updated policy including its id, name, country_code, created_at, and updated_at. Required: id, name.

create_a_people_force_public_holiday_policies_v_2

Create a holiday policy in Peopleforce. Returns the created policy: id, name, country_code, created_at, and updated_at. Requires name and country_code.

delete_a_people_force_public_holiday_policies_v_2_by_id

Delete a holiday policy in Peopleforce by id. Returns an empty 204 response on success. Dependent holidays are cascade-deleted.

list_all_people_force_public_holiday_policies_v_2

List all holiday policies in Peopleforce. Returns each policy's id, name, country_code, created_at, and updated_at.

update_a_people_force_public_holiday_policies_v_2_by_id

Update a holiday policy in Peopleforce by id. Returns the updated policy: id, name, country_code, created_at, and updated_at. Requires id, name, and country_code.

create_a_people_force_public_holiday_policies_v_3

Create a holiday policy in PeopleForce. Returns: id, name, country_code, created_at, updated_at, applicant, pipeline_state. Required: name, country_code.

delete_a_people_force_public_holiday_policies_v_3_by_id

Delete a holiday policy in PeopleForce by id. Returns an empty 204 response on success. Dependent holidays under the policy are cascade-deleted. Required: id.

list_all_people_force_public_holiday_policies_v_3

List holiday policies in PeopleForce. Returns: id, name, country_code, created_at, updated_at, applicant, pipeline_state.

update_a_people_force_public_holiday_policies_v_3_by_id

Update a holiday policy in PeopleForce by id. Returns: id, name, country_code, created_at, updated_at, applicant, pipeline_state. Required: id, name, country_code.

create_a_people_force_public_holiday

Create a holiday in peopleforce. Returns the created holiday with id, name, occurs_on, starts_on, ends_on, working, holiday_policy_id, created_at, and updated_at. Required: name, occurs_on, holiday_policy_id.

delete_a_people_force_public_holiday_by_id

Delete a holiday in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_holidays

List all holidays in peopleforce. Returns each holiday with id, name, occurs_on, starts_on, ends_on, working, holiday_policy_id, created_at, and updated_at.

update_a_people_force_public_holiday_by_id

Update a holiday in peopleforce by id. Returns the updated holiday with id, name, occurs_on, working, holiday_policy_id, created_at, and updated_at. Required: id, name.

create_a_people_force_public_holidays_v_2

Create a holiday in PeopleForce. Returns the created holiday including its id, name, occurs_on, starts_on, ends_on, working flag, and holiday_policy_id. Requires name, occurs_on, and holiday_policy_id.

list_all_people_force_public_holidays_v_2

List all public holidays in peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_holidays_v_3

Create a holiday in Peopleforce. Returns the created holiday with id, name, occurs_on, starts_on, ends_on, working, holiday_policy_id, created_at, and updated_at. Requires name, occurs_on, and holiday_policy_id.

list_all_people_force_public_holidays_v_3

List holidays in Peopleforce. Returns each holiday with id, name, occurs_on, starts_on, ends_on, working, holiday_policy_id, created_at, and updated_at.

list_all_people_force_leave_requests_pendings

List leave requests awaiting approval in peopleforce. Returns: id, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_leave_requests_pendings_pending

List all pending leave requests in peopleforce awaiting approval. Returns: id, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_job_group

Create a job group in Peopleforce. Returns: id, name, parent_id, created_at, updated_at, applicant, pipeline_state. Required: name.

delete_a_people_force_public_job_group_by_id

Delete a job group in Peopleforce by id. Returns an empty 204 response on success.

list_all_people_force_public_job_groups

List all job groups in Peopleforce. Returns: id, name, parent_id, created_at, updated_at, applicant, pipeline_state.

update_a_people_force_public_job_group_by_id

Update a job group in Peopleforce by id. Returns: id, name, parent_id, created_at, updated_at, applicant, pipeline_state. Required: id, name.

create_a_people_force_public_job_groups_v_3

Create a job group in peopleforce. Returns the created group with id, name, parent_id, created_at, and updated_at. Required: name.

delete_a_people_force_public_job_groups_v_3_by_id

Delete a job group from peopleforce by id. Returns an empty 204 response on success.

list_all_people_force_public_job_groups_v_3

List job groups in peopleforce. Returns each group's id, name, parent_id, created_at, and updated_at.

update_a_people_force_public_job_groups_v_3_by_id

Update a job group in peopleforce by id. Returns the updated group with id, name, parent_id, created_at, and updated_at. Required: id, name.

create_a_people_force_public_job_profile

Create a job profile in PeopleForce. Returns the created job profile including its id, name, fields, job_group (with id and name), and created_at/updated_at timestamps. Requires name and job_group_id.

delete_a_people_force_public_job_profile_by_id

Delete a job profile in PeopleForce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_job_profile_by_id

Get a single job profile in PeopleForce by id. Returns: id, name, fields, created_at, updated_at, job_group, applicant, pipeline_state. Required: id.

list_all_people_force_public_job_profiles

List all job profiles in PeopleForce. Returns each profile with: id, name, fields, created_at, updated_at, and job_group (with id and name).

update_a_people_force_public_job_profile_by_id

Update a job profile in PeopleForce by id. Returns the updated job profile including its id, name, fields, job_group (with id and name), and created_at/updated_at timestamps. Requires id and name.

create_a_people_force_public_job_profiles_v_3

Create a job profile in peopleforce. Returns the created profile's id, name, fields, created_at, updated_at, and its parent job_group (id, name). Requires name and job_group_id.

delete_a_people_force_public_job_profiles_v_3_by_id

Delete a job profile in peopleforce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_job_profiles_v_3_by_id

Get a job profile in peopleforce by id. Returns: id, name, fields, created_at, updated_at, job_group, applicant, pipeline_state. Required: id.

list_all_people_force_public_job_profiles_v_3

List job profiles in peopleforce, including job group details for each. Returns: id, name, fields, created_at, updated_at, job_group, applicant, pipeline_state.

update_a_people_force_public_job_profiles_v_3_by_id

Update a job profile in peopleforce by id. Returns the updated profile's id, name, fields, created_at, updated_at, and its parent job_group (id, name). Required: id, name.

create_a_people_force_public_leave_request

Create a leave request in PeopleForce. Returns the created leave request including id, state, amount, hours, starts_on, ends_on, employee, entries, leave_type_policy, and approvals. Requires employee_id, leave_type_id, starts_on, ends_on, description, leave_request_entries, and skip_approval.

delete_a_people_force_public_leave_request_by_id

Delete a PeopleForce leave request by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_leave_request_by_id

Get a PeopleForce leave request by id, including its approvals. Returns: id, created_at, updated_at, applicant, pipeline_state. Required: id.

list_all_people_force_public_leave_requests

List PeopleForce leave requests with optional filters for employee, state, date ranges, and created/updated timestamps. Returns: id, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_leave_requests_v_2

Create a leave request in PeopleForce for an employee. Returns the created leave request including id, state, amount, starts_on, ends_on, entries, employee, leave_type_policy, and approvals. Requires employee_id, leave_type_id, starts_on, ends_on, description, leave_request_entries (per-day occurs_on/amount breakdown), and skip_approval.

delete_a_people_force_public_leave_requests_v_2_by_id

Delete a leave request in PeopleForce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_public_leave_requests_v_2_by_id

Get a leave request by id in PeopleForce. Returns the leave request including id, employee, state, amount, entries, leave_type_policy, and approvals. Required: id.

list_all_people_force_public_leave_requests_v_2

List all leave requests in PeopleForce. Returns leave request records including id, employee, state, amount, entries, leave_type_policy, and approvals.

create_a_people_force_public_leave_requests_v_3

Create a leave request in peopleforce for an employee and leave type over a date range, with per-day entries. Returns: id, created_at, updated_at, applicant, pipeline_state. Required: employee_id, leave_type_id, starts_on, ends_on, description, leave_request_entries, skip_approval.

delete_a_people_force_public_leave_requests_v_3_by_id

Delete a leave request in peopleforce by id. Returns an empty 204 response on success. Required: id.

create_a_people_force_public_leave_type

Create a leave type in Peopleforce. Returns the created leave type including id, name, unit, hex_color, fa_class, and created_at. Required: name.

delete_a_people_force_public_leave_type_by_id

Delete a leave type in Peopleforce by id. Returns an empty 204 response on success.

get_single_people_force_public_leave_type_by_id

Get a single leave type in Peopleforce by id. Returns: id, name, unit, hex_color, fa_class, created_at, applicant, pipeline_state, updated_at. Required: id.

list_all_people_force_public_leave_types

List all leave types in Peopleforce. Returns leave types with id, name, unit, hex_color, fa_class, and created_at.

update_a_people_force_public_leave_type_by_id

Update a leave type in Peopleforce by id. Returns the updated leave type including id, name, unit, hex_color, fa_class, and created_at. Required: id, name.

list_all_people_force_public_leave_types_v_2

List all leave types configured in PeopleForce. Returns each leave type's id, name, unit, hex_color, fa_class, and created_at. No required parameters.

create_a_people_force_public_location

Create a new location in peopleforce. Returns the created location including its id, name, time_zone, country_code, address, holiday_policy_id, created_at, and updated_at. Requires name and time_zone.

list_all_people_force_public_locations

List all locations in peopleforce. Returns tenant location records including id, name, time_zone, country_code, address, holiday_policy_id, created_at, and updated_at.

create_a_people_force_public_locations_v_2

Create a location in Peopleforce. Returns the created location including its id, name, country_code, address, time_zone, holiday_policy_id, created_at, and updated_at. Requires name and time_zone.

list_all_people_force_public_locations_v_2

List all locations in Peopleforce. Returns each location with id, name, country_code, address, time_zone, holiday_policy_id, created_at, and updated_at.

create_a_people_force_public_locations_v_3

Create a location in Peopleforce. Returns the created location: id, name, country_code, address, time_zone, holiday_policy_id, created_at, updated_at. Required: name, time_zone.

create_a_people_force_public_position

Create a new position in PeopleForce. Returns the created position including its id, name, created_at, and updated_at. Requires name.

delete_a_people_force_public_position_by_id

Delete a position in PeopleForce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_positions

List all positions in PeopleForce. Returns positions with id, name, created_at, and updated_at.

update_a_people_force_public_position_by_id

Update a position in PeopleForce by id, renaming it to the supplied name. Returns the updated position including id, name, created_at, and updated_at. Required: id, name.

create_a_people_force_public_positions_v_2

Create a position in Peopleforce. Returns the created position including id, name, created_at, and updated_at. Requires name.

delete_a_people_force_public_positions_v_2_by_id

Delete a position in Peopleforce by id. The record is soft deleted and kept in the database. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_positions_v_2

List all positions in Peopleforce. Returns each position's id, name, created_at, and updated_at. Results are paginated.

update_a_people_force_public_positions_v_2_by_id

Update a position in Peopleforce by id. Returns the updated position including id, name, created_at, and updated_at. Required: id, name.

create_a_people_force_public_positions_v_3

Create a Peopleforce position (job title). Returns the created position including id, name, created_at, and updated_at. Required: name.

delete_a_people_force_public_positions_v_3_by_id

Delete a Peopleforce position by id. Returns an empty 204 response on success. Required: id.

update_a_people_force_public_positions_v_3_by_id

Update (rename) a Peopleforce position by id. Returns the updated position including id, name, created_at, and updated_at. Required: id, name.

create_a_people_force_candidate_education

Create a new education entry for a candidate in PeopleForce. Returns the created education record including its id, school, name, from_year, to_year, subject, and description. Required: candidate_id, school, name, subject, from_year, to_year, description.

delete_a_people_force_candidate_education_by_id

Delete a candidate education entry in PeopleForce by id. Returns an empty 204 response on success. Required: candidate_id, id.

list_all_people_force_candidate_educations

List all education entries for a candidate in PeopleForce. Returns each education record with its id, school, name, from_year, to_year, subject, and description. Required: candidate_id.

update_a_people_force_candidate_education_by_id

Update a candidate education entry in PeopleForce. Returns the updated education record including its id, school, name, from_year, to_year, subject, and description. Required: id, candidate_id, school.

create_a_people_force_candidate_educations_candidate

Create an education entry for a candidate in peopleforce. Returns: id, school, name, from_year, to_year, subject, description, full_name, email, resume, resume_url, applications, custom_fields. Required: candidate_id, school, name, subject, from_year, to_year, description.

delete_a_people_force_candidate_educations_candidate_by_id

Delete a candidate education by id for a candidate in peopleforce. Returns an empty 204 response on success. Required: candidate_id, id.

list_all_people_force_candidate_educations_candidates

List all candidate educations in peopleforce. Returns: id, school, name, from_year, to_year, subject, description, applicant, pipeline_state, created_at, updated_at. Required: candidate_id.

update_a_people_force_candidate_educations_candidate_by_id

Update a candidate education by id for a candidate in peopleforce. Returns: id, school, name, from_year, to_year, subject, description, applicant, pipeline_state, created_at, updated_at. Required: candidate_id, id, school.

create_a_people_force_candidate_experience

Create a work experience record for a candidate in Peopleforce. Returns the created experience including id, title, company, starts_on, ends_on, location, and description. Requires candidate_id, title, company, location, starts_on, ends_on, and description.

delete_a_people_force_candidate_experience_by_id

Delete a candidate experience in Peopleforce by id. Returns an empty 204 response on success. Requires candidate_id and id.

list_all_people_force_candidate_experiences

List work experience records for a Peopleforce candidate. Returns: id, title, company, starts_on, ends_on, location, description, applicant, pipeline_state, created_at, updated_at. Required: candidate_id.

update_a_people_force_candidate_experience_by_id

Update a candidate experience in Peopleforce. Returns the updated experience including id, title, company, starts_on, ends_on, location, and description. Requires candidate_id, id, and title.

create_a_people_force_candidate_experiences_candidate

Create a new experience entry for a candidate in peopleforce. Returns the created experience with id, title, company, starts_on, ends_on, location, and description. Required: candidate_id, title, company, location, starts_on, ends_on, description.

delete_a_people_force_candidate_experiences_candidate_by_id

Delete a candidate experience in peopleforce by id. Returns an empty 204 response on success. Required: id, candidate_id.

list_all_people_force_candidate_experiences_candidates

List all experiences for a candidate in peopleforce. Returns experience records with id, title, company, starts_on, ends_on, location, and description. Required: candidate_id.

update_a_people_force_candidate_experiences_candidate_by_id

Update a candidate experience in peopleforce by id. Returns the updated experience with id, title, company, starts_on, ends_on, location, and description. Required: id, candidate_id, title.

create_a_people_force_public_probation_policy

Create a new probation policy in peopleforce. Returns the created policy with id, name, length, created_at, and updated_at. Requires name and length.

delete_a_people_force_public_probation_policy_by_id

Delete a probation policy in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_probation_policies

List all probation policies in peopleforce. Returns: id, name, length, created_at, updated_at, applicant, pipeline_state. Pagination is handled automatically.

update_a_people_force_public_probation_policy_by_id

Update a probation policy in peopleforce by id. Returns the updated policy with id, name, length, created_at, and updated_at. Required: id, name.

list_all_people_force_public_probation_policies_v_2

List all probation policies in PeopleForce. Returns: id, name, length, created_at, updated_at, applicant, pipeline_state. Pagination is handled automatically.

create_a_people_force_public_probation_policies_v_3

Create a probation policy in Peopleforce. Returns the created policy with id, name, length, created_at, and updated_at. Requires name and length.

delete_a_people_force_public_probation_policies_v_3_by_id

Delete a probation policy in Peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_probation_policies_v_3

List the probation policies configured in Peopleforce. Returns each policy with id, name, length, created_at, and updated_at.

update_a_people_force_public_probation_policies_v_3_by_id

Update a probation policy in Peopleforce by id. Returns the updated policy with id, name, length, created_at, and updated_at. Requires id, name, and length.

list_all_people_force_recruitment_applicant_tags

List all applicant tags in PeopleForce. Returns each tag record with its id, applicant (id, full_name, email, phone_numbers), pipeline_state (id, name), created_at, and updated_at.

list_all_people_force_recruitment_applicant_tags_recruitment

List PeopleForce applicant tags in a paginated collection. Returns: id, name, created_at, updated_at, attributes, custom_fields, meta. Pagination (page, pages, count, items) is handled automatically.

list_all_people_force_recruitment_candidate_fields

List all candidate fields configured in PeopleForce. Returns: id, name, internal_name, type, options, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_recruitment_candidate_fields_recruitment

List all candidate fields configured for the PeopleForce tenant. Returns each field's id, name, internal_name, type, created_at, and updated_at.

create_a_people_force_recruitment_candidate

Create a candidate in PeopleForce with a name, email, and optional profile details such as phone numbers, cover letter, resume, source, and custom fields. Returns the created candidate including id, full_name, email, resume_url, applications, custom_fields, consent, and created_at. Required: full_name, email.

delete_a_people_force_recruitment_candidate_by_id

Delete a candidate from PeopleForce by id. Returns an empty 204 response on success.

get_single_people_force_recruitment_candidate_by_id

Get a PeopleForce candidate by id. Returns the full candidate record including id, full_name, email, cover_letter, resume_url, applications, custom_fields, consent, and created_at/updated_at. Required: id.

list_all_people_force_recruitment_candidates

List all candidates in PeopleForce. Returns each candidate with id, full_name, email, applications, custom_fields, consent, and timestamps; supports created_at/updated_at range filters and phone_numbers lookup.

update_a_people_force_recruitment_candidate_by_id

Update a PeopleForce candidate by id. Returns the updated candidate including id, full_name, email, resume_url, applications, custom_fields, consent, and timestamps. Required: id, full_name.

create_a_people_force_recruitment_candidates_recruitment

Create a candidate in PeopleForce with the candidate's full name and email. Returns the created candidate with id, full_name, email, cover_letter, resume, resume_url, applications, and custom_fields. Requires full_name and email. Duplicates are auto-matched by email and CV.

delete_a_people_force_recruitment_candidates_recruitment_by_id

Delete a candidate in PeopleForce by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_recruitment_candidates_recruitment_by_id

Get a single candidate in PeopleForce by id. Returns the candidate with id, full_name, email, resume, resume_url, applications, custom_fields, applicant, pipeline_state, created_at, and updated_at. Required: id.

list_all_people_force_recruitment_candidates_recruitment

List all candidates in PeopleForce. Returns candidate records with id, full_name, email, resume, resume_url, applications, custom_fields, applicant, pipeline_state, created_at, and updated_at. Filterable by created_at, updated_at, email, phone_numbers[], pipeline_stage_id, skills[], and vacancy_ids[].

update_a_people_force_recruitment_candidates_recruitment_by_id

Update a candidate in PeopleForce by id. Returns the updated candidate with id, full_name, email, cover_letter, resume, resume_url, applications, custom_fields, applicant, pipeline_state, created_at, and updated_at. Required: id.

list_all_people_force_recruitment_disqualify_reasons

List all disqualify reasons in PeopleForce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_recruitment_disqualify_reasons_recruitment

List all disqualify reasons in Peopleforce recruitment. Returns: id, name, created_at, updated_at, applicant, pipeline_state. The reason id is referenced as disqualify_reason_id when disqualifying an application.

list_all_people_force_recruitment_pipelines

List all vacancy pipelines in peopleforce. Returns: id, name, stages, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_recruitment_pipelines_recruitment

List all vacancy pipelines in PeopleForce. Returns each pipeline's id, name, created_at, and updated_at.

create_a_people_force_recruitment_source

Create a new recruitment source in peopleforce. Returns the created source including its id and name. Required: name.

delete_a_people_force_recruitment_source_by_id

Delete a recruitment source in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_recruitment_sources

List all recruitment sources in peopleforce. Each source includes its id and name.

update_a_people_force_recruitment_source_by_id

Update a recruitment source in peopleforce by id, renaming it to the supplied name. Returns the updated source including its id and name. Required: id, name.

list_all_people_force_recruitment_sources_recruitment

List all recruitment sources configured in Peopleforce. Returns: id, name, applicant, pipeline_state, created_at, updated_at.

create_a_people_force_application_disqualify

Disqualify a vacancy application in peopleforce. Returns the updated application including its id, applicant details (full_name, email, phone_numbers), disqualify_reason, and disqualified_at. Required: vacancy_id, application_id, disqualify_reason_id.

create_a_people_force_application_disqualifies_disqualify

Disqualify a PeopleForce vacancy application with a disqualify reason. Returns the updated application including its id, applicant, disqualify_reason, disqualified_at, and created_at / updated_at timestamps. Required: vacancy_id, application_id, disqualify_reason_id.

people_force_application_moves_bulk_update

Move a PeopleForce vacancy application to a different pipeline stage. Returns the updated application object including id, applicant (full_name, email, phone_numbers), pipeline_state (id, name), disqualified_at, created_at, and updated_at. Required: vacancy_id, application_id, pipeline_stage_id. The vacancy must be published; draft, closed, or archived vacancies return 404.

people_force_application_moves_move_bulk_update

Move a Peopleforce vacancy application to a different pipeline stage. Returns the updated application including id, applicant (full_name, email, phone_numbers), pipeline_state, and created_at/updated_at timestamps. Required: vacancy_id, application_id, pipeline_stage_id.

list_all_people_force_hr_leave_balances

Get the leave balances report from Peopleforce HR reports. Returns an empty 204 response on success.

list_all_people_force_hr_working_hours

Get the working hours report from peopleforce. Returns report rows with id, applicant, pipeline_state, created_at, and updated_at.

list_all_people_force_hr_working_hours_hr

Get the HR working hours report in Peopleforce. Returns the report rows as an array of records with report-specific fields; the row shape is not enumerated in the API documentation.

get_single_people_force_public_session_by_id

Get the current PeopleForce session. Returns: name, data. No required parameters.

list_all_people_force_public_sessions

Get current session info for the current PeopleForce session via the v2 API. Returns: name, data. No required parameters.

people_force_public_tasks_bulk_update

Complete a task in PeopleForce (v2). Marks the task identified by task_id as completed. Returns the updated task under data, including id, title, completed, completed_at, and assigned_to. Required: task_id.

create_a_people_force_public_task

Create a task in PeopleForce assigned to an employee. Returns: id, type, created_at, updated_at, applicant, pipeline_state. Requires name, description, employee_id, and starts_on.

list_all_people_force_public_tasks

List all tasks in PeopleForce. Returns task records including id, title, starts_on, ends_on, completed, completed_at, assigned_to, and created_by.

people_force_public_tasks_update_complete

Complete a task in PeopleForce. Marks the task identified by task_id as completed. Returns the updated task under data, including id, title, completed, completed_at, and assigned_to. Required: task_id.

people_force_public_tasks_complete_bulk_update

Complete a PeopleForce task by id, marking it as done. Returns a data object with the completed task's id, title, completed status, completed_at, and assigned_to. Required: task_id.

create_a_people_force_public_tasks_v_2

Create a task in Peopleforce assigned to an employee. Returns: id, type, created_at, updated_at, applicant, pipeline_state. Requires name, description, employee_id, and starts_on.

list_all_people_force_public_tasks_v_2

List all Peopleforce tasks, optionally filtered by start and end date ranges. Returns task objects including id, type, title, starts_on, ends_on, completed, assigned_to, and created_at.

create_a_people_force_public_tasks_v_3

Create a task in Peopleforce. Returns the created task including its id, type, title, starts_on, completed flag, assigned_to, and created_by. Requires name, description, employee_id, and starts_on.

list_all_people_force_public_tasks_v_3

List tasks in Peopleforce. Returns the tenant's incomplete tasks by default, each with id, title, starts_on, ends_on, completed, assigned_to, and created_by. Narrow results with starts_on[gte], starts_on[lte], ends_on[gte], or ends_on[lte].

create_a_people_force_public_team

Create a team in PeopleForce. Returns the created team object including id, name, description, created_at, updated_at, team_lead, and team_members. Requires name, description, and team_lead_id.

delete_a_people_force_public_team_by_id

Delete a PeopleForce team by id. The team is soft-deleted. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_teams

List all teams in PeopleForce. Returns each team with id, name, description, created_at, updated_at, team_lead, and team_members.

update_a_people_force_public_team_by_id

Update a PeopleForce team by id. Returns the updated team object including id, name, description, created_at, updated_at, team_lead, and team_members. Requires id, name, and description.

create_a_people_force_public_teams_v_2

Create a team in Peopleforce. Returns the created team object including id, name, description, created_at, updated_at, team_lead, and team_members. Requires name, description, and team_lead_id.

list_all_people_force_public_teams_v_2

List all teams in Peopleforce. Returns each team with id, name, description, created_at, updated_at, team_lead, and team_members.

update_a_people_force_public_teams_v_2_by_id

Update a team in Peopleforce by id. Returns the updated team object including id, name, description, created_at, updated_at, team_lead, and team_members. Required: id, name.

delete_a_people_force_public_teams_v_2_by_id

Delete a team in Peopleforce by id. Returns an empty 204 response on success. Required: id.

create_a_people_force_public_teams_v_3

Create a team in Peopleforce. Returns the created team including id, name, description, created_at, updated_at, team_lead, and team_members. Requires name, description, and team_lead_id.

delete_a_people_force_public_teams_v_3_by_id

Delete a team in Peopleforce by id. The team is soft-deleted. Returns an empty 204 response on success.

update_a_people_force_public_teams_v_3_by_id

Update a team in Peopleforce by id. Returns the updated team including id, name, description, created_at, updated_at, team_lead, and team_members. Requires id, name, and description.

people_force_task_incompletes_bulk_update

Mark a Peopleforce task as incomplete by its id. Returns the updated task under data, including id, title, starts_on, ends_on, completed, completed_at, assigned_to, created_by, created_at, and updated_at. Required: task_id.

people_force_task_incompletes_incomplete_bulk_update

Mark a PeopleForce task as incomplete, clearing its completion state. Returns the updated task object including its id, title, completed, completed_at, and assigned_to. Required: task_id.

create_a_people_force_recruitment_vacancy

Create a vacancy in peopleforce. Returns the created vacancy including id, title, state, priority, positions, department, location, and recruitment_pipeline. Required: title, description, positions, recruitment_pipeline_id, hiring_lead_user_id, employment_type_id, department_id, location_id.

delete_a_people_force_recruitment_vacancy_by_id

Delete a vacancy by id in peopleforce. Returns an empty 204 response on success. Required: id.

get_single_people_force_recruitment_vacancy_by_id

Get a single vacancy by id in peopleforce. Returns the vacancy including id, title, state, priority, positions, department, location, recruitment_pipeline, and hiring_lead. Required: id.

list_all_people_force_recruitment_vacancies

List all vacancies in peopleforce with filters for status, title, start/end dates, locations, and tags. Returns vacancies including id, title, state, priority, positions, department, location, and recruitment_pipeline.

update_a_people_force_recruitment_vacancy_by_id

Update a vacancy by id in peopleforce. Returns the updated vacancy including id, title, state, priority, positions, department, location, and recruitment_pipeline. Required: id, title.

create_a_people_force_recruitment_vacancies_recruitment

Create a PeopleForce vacancy. Returns the created vacancy including id, title, state, priority, positions, department, location, recruitment_pipeline, and hiring_lead. Requires title, description, positions, recruitment_pipeline_id, hiring_lead_user_id, employment_type_id, department_id, and location_id.

delete_a_people_force_recruitment_vacancies_recruitment_by_id

Delete a PeopleForce vacancy by id. Returns an empty 204 response on success. Required: id.

get_single_people_force_recruitment_vacancies_recruitment_by_id

Get a PeopleForce vacancy by id. Returns the full vacancy object including id, title, state, priority, positions, department, location, employment_type, recruitment_pipeline, and hiring_lead. Required: id.

list_all_people_force_recruitment_vacancies_recruitment

List PeopleForce vacancies, filterable by title, start/end dates, legal entity, locations, and tags. Returns vacancy objects including id, title, state, priority, positions, department, location, recruitment_pipeline, and hiring_lead. Sorts by opened_at ascending by default.

update_a_people_force_recruitment_vacancies_recruitment_by_id

Update a PeopleForce vacancy by id. Returns the full updated vacancy object including id, title, state, priority, positions, department, location, employment_type, recruitment_pipeline, and hiring_lead. Required: id, title. The body is form-encoded.

list_all_people_force_recruitment_vacancy_fields

List all vacancy fields in Peopleforce. Returns each field's id, name, internal_name, type, created_at, and updated_at. No request parameters are required.

list_all_people_force_recruitment_vacancy_fields_recruitment

List all vacancy fields defined in PeopleForce recruitment. Returns: id, name, internal_name, type, created_at, updated_at, applicant, pipeline_state. No required parameters.

list_all_people_force_recruitment_vacancy_tags

List all vacancy tags in PeopleForce — the labels available for categorizing vacancies. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_recruitment_vacancy_tags_recruitment

List vacancy tags available for Peopleforce recruitment vacancies. Returns: id, created_at, updated_at, applicant, pipeline_state. Upstream documents the record fields as untyped, so additional tag attributes follow the Peopleforce v2 record format.

create_a_people_force_vacancie_application

Create a PeopleForce vacancy application by attaching an existing applicant to a published vacancy. Returns the created application with id, applicant, pipeline_state, and created_at. Requires vacancy_id and applicant_id; draft, closed, or archived vacancies return 404.

get_single_people_force_vacancie_application_by_id

Get a single PeopleForce vacancy application by id within a vacancy. Returns the application including id, applicant, pipeline_state, disqualified_at, and created_at. Requires vacancy_id and id.

list_all_people_force_vacancie_applications

List all applications for a PeopleForce vacancy. Returns: id, applicant, pipeline_state, disqualified_at, created_at, updated_at. Required: vacancy_id.

update_a_people_force_vacancie_application_by_id

Update a PeopleForce vacancy application by moving it to a different pipeline state. Returns the updated application with id, applicant, pipeline_state, disqualified_at, and updated_at. Requires applicant_state_id, vacancy_id, and id.

create_a_people_force_vacancie_applications_vacancy

Create a vacancy application in PeopleForce by attaching an existing candidate to a vacancy. Returns the application with its id, applicant, pipeline_state, disqualified_at, created_at, and updated_at. Required: vacancy_id, applicant_id.

get_single_people_force_vacancie_applications_vacancy_by_id

Get a single application for a PeopleForce vacancy by id. Returns the application with its id, applicant, pipeline_state, disqualified_at, created_at, and updated_at. Required: vacancy_id, id.

list_all_people_force_vacancie_applications_vacancies

List all applications for a PeopleForce vacancy. Returns applications with their id, applicant, pipeline_state, disqualified_at, created_at, and updated_at. Required: vacancy_id.

update_a_people_force_vacancie_applications_vacancy_by_id

Update a vacancy application in PeopleForce. Returns the application with its id, applicant, pipeline_state, disqualified_at, created_at, and updated_at. Required: vacancy_id, id, applicant_id.

list_all_people_force_employee_field_histories

List a Peopleforce employee's field history rows, showing how a historical field's value changed over time. Returns: employee_field_internal_name, effective_on, value, id, applicant, pipeline_state, created_at, updated_at. Required: employee_id.

list_all_people_force_employee_field_histories_employees

List field history rows for a PeopleForce employee's historical fields, showing how each value changed over time. Returns: employee_field_internal_name, effective_on, value, id, applicant, pipeline_state, created_at, updated_at. Required: employee_id.

create_a_people_force_employee_skill

Add a skill to a PeopleForce employee using the legacy v2 API (prefer the v3 employee_skills_employees.create). Returns the created record with id, level and skill. Required: employee_id, skill_id, level.

delete_a_people_force_employee_skill_by_id

Remove a skill from a PeopleForce employee using the legacy v2 API (prefer v3). Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employee_skills

List the skills of a PeopleForce employee using the legacy v2 API. Prefer employee_skills_employees.list (v3). Returns: id, level, skill (id, name). Required: employee_id.

update_a_people_force_employee_skill_by_id

Change the level of a PeopleForce employee skill using the legacy v2 API (prefer v3). Returns the updated record. Required: employee_id, id, level.

create_a_people_force_employee_skills_employee

Add a skill to a PeopleForce employee (v3) with a proficiency level. Returns the created skill record with id, level and skill. Required: employee_id, skill_id, level.

list_all_people_force_employee_skills_employees

List the skills of a PeopleForce employee (v3). Returns: id, level, skill (id, name). Required: employee_id.

update_a_people_force_employee_skills_employee_by_id

Change the proficiency level of a PeopleForce employee skill (v3). Returns the updated record with id, level and skill. Required: employee_id, id, level.

delete_a_people_force_employee_skills_employee_by_id

Remove a skill from a PeopleForce employee (v3). Returns an empty 204 response on success. Required: employee_id, id.

list_all_people_force_employees_anniversaries

List employees with a work anniversary in a date range using the legacy v2 API (prefer employees_anniversaries_employees.list). Returns v2 employee records with id, full_name, email, hired_on, position, department, custom_fields. Optional: date[gte], date[lte].

list_all_people_force_employees_anniversaries_employees

List employees with a work anniversary in a date range in PeopleForce (v3). Returns employee records (id, full_name, email, hired_on, position, department, …). Optional: date[gte], date[lte].

list_all_people_force_employees_birthdays

List employees with a birthday in a date range using the PeopleForce v2 API. Returns v2 employee records with id, full_name, email, date_of_birth, position, department, custom_fields. Optional: date[gte], date[lte].

list_all_people_force_employees_birthdays_employees

List employee birthdays in Peopleforce. Returns each employee's id, full_name, date_of_birth, email, department, position, and employment_type. Optional date[gte] and date[lte] date filters restrict the returned range.

list_all_people_force_public_audits

List audit log entries in PeopleForce (v2): record creates, updates and deletes with the acting employee, filterable by created time. Returns: id, event, record_id, record_type, created_at, employee, custom_table_fields.

list_all_people_force_public_audits_v_3

List audit entries recorded in Peopleforce. Returns: id, created_at, applicant, pipeline_state, updated_at.

list_all_people_force_public_competencies

List all competencies in Peopleforce. Returns a paginated collection of competency records with: id, name, description, type, created_at, and updated_at.

list_all_people_force_public_competencies_v_3

List competencies in peopleforce. Returns each competency's id, name, description, type, created_at, and updated_at, paginated.

list_all_people_force_public_employee_tables

List all employee tables in Peopleforce. Returns each active table with its id, name, internal_name, description, group, columns, and created_at/updated_at timestamps.

list_all_people_force_public_employee_tables_v_3

List the custom employee tables defined in peopleforce. Returns each table's id, name, internal_name, description, group, columns, created_at, and updated_at.

create_a_people_force_public_termination_reason

Create a new termination reason in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: name.

delete_a_people_force_public_termination_reason_by_id

Delete a Peopleforce termination reason by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_termination_reasons

List the tenant's termination reasons in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Note: mutations use v2 while listing is served from v1.

update_a_people_force_public_termination_reason_by_id

Update an existing termination reason in Peopleforce by id. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: id and name.

list_all_people_force_public_termination_reasons_v_2

List termination reasons in PeopleForce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_termination_reasons_v_3

Create a new termination reason in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: name.

delete_a_people_force_public_termination_reasons_v_3_by_id

Delete a termination reason in Peopleforce by id. Returns an empty 204 response on success.

list_all_people_force_public_termination_reasons_v_3

List termination reasons in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

update_a_people_force_public_termination_reasons_v_3_by_id

Update a termination reason in Peopleforce by id. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Required: id, name.

create_a_people_force_public_termination_type

Create a new termination type in Peopleforce. Returns the created termination type including its id, name, created_at, and updated_at. Requires name.

delete_a_people_force_public_termination_type_by_id

Delete a termination type in Peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_termination_types

List all termination types in Peopleforce. Returns each type's id, name, created_at, and updated_at.

update_a_people_force_public_termination_type_by_id

Update a termination type in Peopleforce by id. Returns the updated termination type including its id, name, created_at, and updated_at. Requires name and id.

list_all_people_force_public_termination_types_v_2

List all termination types in PeopleForce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_termination_types_v_3

Create a termination type in Peopleforce. Returns the created termination type object: id, name, created_at, updated_at. Required: name.

delete_a_people_force_public_termination_types_v_3_by_id

Delete a termination type in Peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_termination_types_v_3

List termination types in Peopleforce. Returns a paginated collection of records with: id, name, created_at, updated_at.

update_a_people_force_public_termination_types_v_3_by_id

Update a termination type in Peopleforce by id. Returns the updated termination type object: id, name, created_at, updated_at. Required: id, name.

create_a_people_force_public_webhook

Create a webhook subscription in PeopleForce that delivers events to a callback URL. Returns: id, created_at, data. Requires url, name, and event.

delete_a_people_force_public_webhook_by_id

Delete a PeopleForce webhook subscription by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_workflows

List workflows in PeopleForce. Returns workflow records including their id and upstream-defined attributes; the remaining record fields are not enumerated in the API docs.

list_all_people_force_public_workflows_v_2

List workflows in Peopleforce. Returns an array of workflow records; the upstream documentation does not enumerate the per-item fields.

create_a_people_force_team_team_member

Create a team member in Peopleforce by adding an existing user to a team. Returns: id, team_id, user_id, created_at, updated_at, applicant, pipeline_state. Required: team_id, user_id.

delete_a_people_force_team_team_member_by_id

Delete a team member from a Peopleforce team by id. Returns an empty 204 response on success. Required: team_id, id.

create_a_people_force_team_team_members_team

Create a team member in a Peopleforce team by adding an existing user. Returns the created team member object with id, team_id, user_id, created_at, and updated_at. Required: team_id, user_id.

delete_a_people_force_team_team_members_team_by_id

Delete a team member from a Peopleforce team by id. Hard-deletes the team member record. Returns an empty 204 response on success. Required: team_id, id.

list_all_people_force_webhooks_lists

List webhook subscriptions in PeopleForce. Returns records with id, employee attributes (employee_number, first_name, email), related reporting_to/position/department objects, custom_fields, and meta created_at/updated_at. Optional query parameter: key.

list_all_people_force_webhooks_lists_list

List webhooks in PeopleForce. Returns each record with its id, attributes, department, position, custom_fields, and meta created_at/updated_at timestamps.

create_a_people_force_candidate_note

Create a note on a candidate in peopleforce. Returns the created note including id, comment, created_by (user id, first_name, last_name, email), created_at, and updated_at. Required: candidate_id, comment.

list_all_people_force_candidate_notes

List all notes attached to a candidate in peopleforce. Returns each note with id, comment, created_by, created_at, and updated_at. Required: candidate_id.

create_a_people_force_candidate_notes_candidate

Create a note on a candidate in Peopleforce. Returns the created note: id, comment, created_by (id, first_name, last_name, email), created_at, and updated_at. Required: candidate_id, comment.

list_all_people_force_candidate_notes_candidates

List all notes for a candidate in PeopleForce. Returns: id, comment, created_by, created_at, updated_at, applicant, pipeline_state. Required: candidate_id.

list_all_people_force_categorie_articles

List all articles in a Peopleforce knowledge base category. Returns: id, position, created_at, updated_at, applicant, pipeline_state. Required: category_id.

list_all_people_force_categorie_articles_categories

List articles in a PeopleForce knowledge base category. Returns each article's id, title, rich-text body, position, category (id, name, parent_id), and created_at/updated_at timestamps. Required: category_id.

get_single_people_force_employee_table_by_id

Get a single employee table for a specific employee in Peopleforce. Returns the table's id, name, internal_name, description, and its rows. Required: employee_id, id.

get_single_people_force_employee_tables_employee_by_id

Get a single custom employee table in peopleforce for a given employee, including the table definition and all of its stored rows. Returns: id, name, internal_name, description, rows, applicant, pipeline_state, created_at, updated_at. Required: employee_id, id.

people_force_employee_update_avatars_bulk_update

Update an employee's avatar in peopleforce by uploading the new avatar image for the employee identified by employee_id. Returns the updated employee record including id, employee_number, full_name, email, and avatar_url. Required: employee_id and avatar.

people_force_employee_update_avatars_update_avatar_bulk_update

Update an employee's avatar in peopleforce. Returns the updated employee object including id, full_name, email, avatar_url, position, department, and custom_fields. Required: employee_id, avatar.

key_performance_indicator_key_performance_indicator_results_crea

Create a progress record for a key performance indicator in peopleforce. Returns the created KPI result including its id, value, comment, occurred_on, the parent key_performance_indicator object, created_at, and updated_at. Required: key_performance_indicator_id, occurred_on, value, comment.

key_performance_indicator_key_performance_indicator_results_key_

Create a key performance indicator result for a KPI in peopleforce. Returns the created result with id, value, comment, occurred_on, created_at, updated_at, and its full key_performance_indicator object. Required: key_performance_indicator_id, value, occurred_on, comment.

get_single_people_force_knowledge_base_article_by_id

Get a single knowledge base article in PeopleForce by id. Returns: id, position, created_at, updated_at, applicant, pipeline_state. Required: id.

get_knowledge_base_articles_knowledge_base_by_id

Get a PeopleForce knowledge base article by id. Returns the full article object including its id, title, body, body_html, editor_version, position, category, created_by, created_at, and updated_at. Required: id. Returns the published title, not the draft title.

list_all_people_force_knowledge_base_categories

List all knowledge base categories in PeopleForce. Returns: id, name, description, css_class, emoji, hex_color, position, parent_id, created_by, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_knowledge_base_categories_knowledge_base

List the tenant's knowledge base categories in Peopleforce. Returns each category's id, name, position, parent_id, created_by (id, first_name, last_name, email), created_at, and updated_at; description, css_class, emoji, and hex_color may be null.

create_a_people_force_performance_key_performance_indicator

Create a key performance indicator in Peopleforce. Returns the created KPI including id, title, weight, kpi_type, metric, status, currency_code, its location, department, division, and owner. Required: title, kpi_type, description, department_id, location_id, currency_code, weight, metric, user_id.

list_all_people_force_performance_key_performance_indicators

List all key performance indicators in Peopleforce. Returns: id, location, division, department, created_at, updated_at, applicant, pipeline_state.

create_performance_key_performance_indicators_performance

Create a key performance indicator (KPI) in peopleforce. Returns the created KPI including its id, title, metric, kpi_type, status, and owner. Required: title, kpi_type, metric, user_id.

list_all_performance_key_performance_indicators_performance

List key performance indicators in peopleforce. Returns KPI records with id, title, metric, kpi_type, status, and their related location, division, and department objects.

list_all_people_force_performance_objectives

List all performance objectives in peopleforce. Returns each objective with id, title, progress, status, starts_on, ends_on, parent_id, key_results, owner, created_at, and updated_at.

list_all_people_force_performance_objectives_performance

List performance objectives in PeopleForce. Returns each objective's id, title, progress, status, starts_on, ends_on, parent_id, key_results, owner, created_at, and updated_at. Optionally filter by starts_on and ends_on date ranges.

list_all_people_force_performance_review_cycles

List performance review cycles in peopleforce. Returns each cycle's id, name, description, state, starts_on/ends_on dates, and review_cycle_type. Filter by review_cycle_type (manual or lifecycle) and by starts_on/ends_on date ranges.

list_all_people_force_performance_review_cycles_performance

List PeopleForce performance review cycles, optionally filtered by start/end date range and cycle type. Returns: id, name, applicant, pipeline_state, created_at, updated_at.

list_all_people_force_public_external_users

List all external users in peopleforce. Returns: id, active, access, full_name, first_name, last_name, email, role, created_at, updated_at, applicant, pipeline_state. Optionally filter by created_at[gte] and created_at[lte] dates.

list_all_people_force_public_external_users_v_3

List external users in PeopleForce with each record's portal active/access state. Returns: id, active, access, full_name, first_name, last_name, email, role, resume, resume_url, applications, custom_fields, created_at, updated_at, applicant, pipeline_state. Optional date filters: created_at[gte], created_at[lte].

create_a_people_force_public_gender

Create a gender in peopleforce. Returns the created gender record: id, name, system, created_at, updated_at. Required: name.

delete_a_people_force_public_gender_by_id

Delete a gender in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_genders

List genders in peopleforce. Returns gender records with: id, name, system, created_at, updated_at.

update_a_people_force_public_gender_by_id

Update a gender's name in peopleforce by id. Returns the updated gender record: id, name, system, created_at, updated_at. Required: id, name.

create_a_people_force_public_genders_v_3

Create a gender in peopleforce. Returns the created gender: id, name, system, created_at, updated_at. Required: name.

delete_a_people_force_public_genders_v_3_by_id

Delete a gender in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_genders_v_3

List genders configured in peopleforce. Returns each gender with: id, name, system, created_at, updated_at.

update_a_people_force_public_genders_v_3_by_id

Update a gender's name in peopleforce by id. Returns the updated gender: id, name, system, created_at, updated_at. Required: id, name.

list_all_people_force_public_job_levels

List all job levels in PeopleForce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_public_job_levels_v_3

List job levels in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_leave_adjustment

Create a leave adjustment in Peopleforce that updates an employee's leave history. Returns the created adjustment record including id, applicant, pipeline_state, created_at, and updated_at. Requires employee_id, leave_type_id, occurred_on, amount, and description.

create_a_people_force_public_leave_adjustments_v_3

Create a leave adjustment in peopleforce that updates an employee's leave history. Returns the created adjustment record including its id, created_at, and updated_at. Required: employee_id, leave_type_id, occurred_on, amount, description.

list_all_people_force_public_leave_policies

List all leave policies configured in peopleforce. Returns: id, name, activity_type, counted_as, leave_type_id, visibility, type, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_public_pay_schedules

List all pay schedules in Peopleforce. Returns each pay schedule's id, name, created_at, and updated_at.

list_all_people_force_public_pay_schedules_v_3

List pay schedules in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_review_answers

List all review answers for a performance review in Peopleforce. Returns: id, type, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id, review_id.

list_all_people_force_review_answers_reviews

List performance review answers in peopleforce for a specific review within a review cycle. Returns: id, review_participant_id, type, text, comment, rating, review_question_id, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id, review_id.

list_all_people_force_review_cycle_reviews

List all reviews in a PeopleForce performance review cycle. Returns: id, employee_id, review_cycle_id, state, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id.

list_all_people_force_review_cycle_reviews_review_cycles

List the performance reviews in a peopleforce review cycle. Returns: id, employee_id, review_cycle_id, state, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id.

list_all_people_force_review_questions

List all review questions for a Peopleforce performance review. Returns: id, title_self, type, title_manager, title, competency_id, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id, review_id.

list_all_people_force_review_questions_reviews

List the questions of a performance review within a review cycle in peopleforce. Returns: id, title_self, type, title_manager, title, competency_id, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id, review_id. The response may include all questions for the review cycle, ignoring review_id.

list_all_people_force_review_review_participants

List all review participants for a specific review in peopleforce. Returns: id, employee_id, review_id, state, type, applicant, pipeline_state, created_at, updated_at. Required: review_cycle_id, review_id.

list_all_people_force_review_review_participants_reviews

List review participants for a specific review within a PeopleForce performance review cycle. Returns each participant's id, employee_id, review_id, state, and type. Required: review_cycle_id, review_id.

create_a_people_force_column_option

Create a new option for a column in a PeopleForce employee table. Returns: id, value, applicant, pipeline_state, created_at, updated_at. Required: employee_table_id, column_id, value.

delete_a_people_force_column_option_by_id

Delete a column option from a PeopleForce employee table column. Returns an empty 204 response on success. Required: id, employee_table_id, column_id.

list_all_people_force_column_options

List the selectable options for a PeopleForce employee table column. Returns: id, value, applicant, pipeline_state, created_at, updated_at. Required: employee_table_id, column_id.

update_a_people_force_column_option_by_id

Update a column option in peopleforce by id. Returns: id, value, applicant, pipeline_state, created_at, updated_at. Required: id, employee_table_id, column_id, value.

create_a_people_force_employee_field_option

Create a new option for an employee field in Peopleforce. Returns: id, value, applicant, pipeline_state, created_at, updated_at. Required: employee_field_id, value.

delete_a_people_force_employee_field_option_by_id

Delete an employee field option in Peopleforce by id. Returns an empty 204 response on success. Required: employee_field_id, id.

list_all_people_force_employee_field_options

List options of an employee field in Peopleforce. Returns: id, value, applicant, pipeline_state, created_at, updated_at. Required: employee_field_id.

update_a_people_force_employee_field_option_by_id

Update an employee field option in Peopleforce. Returns: id, value, applicant, pipeline_state, created_at, updated_at. Required: employee_field_id, id, value.

list_all_people_force_employee_job_profiles

List job profiles assigned to a PeopleForce employee. Returns each record's id, effective_on, created_at, updated_at, and its job_profile and job_group objects. Required: employee_id.

create_a_people_force_employee_job_profile

Create a job profile assignment for a PeopleForce employee. Returns the created record's id, effective_on, created_at, updated_at, and its job_profile and job_group objects. Required: employee_id, job_profile_id, effective_on.

delete_a_people_force_employee_job_profile_by_id

Delete a job profile assignment from a PeopleForce employee by id. Returns an empty 204 response on success. Required: employee_id, id.

update_a_people_force_employee_job_profile_by_id

Update a job profile assignment for a PeopleForce employee by id. Returns the updated record's id, effective_on, created_at, updated_at, and its job_profile and job_group objects. Required: employee_id, id, job_profile_id, effective_on.

list_all_people_force_employee_table_columns

List the columns of a PeopleForce employee table. Returns: id, name, internal_name, type, options, applicant, pipeline_state, created_at, updated_at. Required: employee_table_id.

people_force_employees_positions_bulk_update

Bulk update employee position records in Peopleforce by submitting an array of position updates. Returns: records, errors, data. Required: data, where each item needs employee_id and id.

people_force_employees_salaries_bulk_update

Bulk update employee salary records in peopleforce by submitting a data array of salary updates, each item requiring employee_id and the salary record id. Returns the records envelope with the count and updated salary rows (id, effective_on, amount, currency_code, per) and an errors envelope with the count of failed rows. Required: data.

create_a_people_force_public_compensation_component

Create an additional base compensation component in peopleforce. Returns the created component including its id, name, code, category, payout_type, frequency, and description. Requires name, category, and payout_type.

delete_a_people_force_public_compensation_component_by_id

Delete a compensation component in peopleforce by id. Returns an empty 204 response on success.

list_all_people_force_public_compensation_components

List compensation components in peopleforce. Returns each component with id, name, code, category, payout_type, frequency, and description.

update_a_people_force_public_compensation_component_by_id

Update a compensation component in peopleforce by id, for example to rename it or change its category. Returns the updated component: id, name, code, category, payout_type, frequency, and description. Required: id.

create_a_people_force_public_skill

Create a skill in Peopleforce. Returns the created skill with id, name, created_at, and updated_at. Required: name.

delete_a_people_force_public_skill_by_id

Delete a skill in Peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_skills

List all skills in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_skills_v_3

Create a skill in peopleforce for the tenant. Returns the created skill including its id, name, created_at, and updated_at. Requires name.

delete_a_people_force_public_skills_v_3_by_id

Delete a skill in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_skills_v_3

List skills for the peopleforce tenant. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

create_a_people_force_public_working_pattern

Create a working pattern in PeopleForce with scheduled hours for each weekday. Returns the created pattern with id, name, the seven daily hour fields (monday_hours through sunday_hours), created_at, and updated_at. Required: name, monday_hours, tuesday_hours, wednesday_hours, thursday_hours, friday_hours, saturday_hours, sunday_hours.

delete_a_people_force_public_working_pattern_by_id

Delete a PeopleForce working pattern by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_working_patterns

List PeopleForce working patterns configured for the account. Returns each pattern with id, name, the daily hour fields (monday_hours through sunday_hours), created_at, and updated_at.

update_a_people_force_public_working_pattern_by_id

Update a PeopleForce working pattern by id, setting its name and scheduled hours for each weekday. Returns the updated pattern with id, name, the seven daily hour fields (monday_hours through sunday_hours), created_at, and updated_at. Required: id, name, monday_hours, tuesday_hours, wednesday_hours, thursday_hours, friday_hours, saturday_hours, sunday_hours.

create_a_people_force_public_working_patterns_v_3

Create a working pattern in peopleforce with scheduled hours for each weekday. Returns the created pattern including id, name, the per-day hour fields (monday_hours through sunday_hours), created_at, and updated_at. Requires name, monday_hours, tuesday_hours, wednesday_hours, thursday_hours, friday_hours, saturday_hours, and sunday_hours.

delete_a_people_force_public_working_patterns_v_3_by_id

Delete a working pattern in peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_public_working_patterns_v_3

List the peopleforce tenant's working patterns. Returns each pattern's id, name, the per-day hour fields (monday_hours through sunday_hours), created_at, and updated_at.

update_a_people_force_public_working_patterns_v_3_by_id

Update a peopleforce working pattern by id. Returns the updated pattern including id, name, the per-day hour fields (monday_hours through sunday_hours), created_at, and updated_at. Requires id, name, and friday_hours.

create_a_people_force_project_project_user

Bulk assign employees to a project in PeopleForce. Returns records (with count and a data array of employee_id, project_user_id) and errors (with count and data) for any failed assignments. Required: project_id, employee_ids.

create_a_people_force_project_project_users_project

Assign employees to a project in peopleforce. Returns the assignment result split into records (successful assignments, each with employee_id and project_user_id) and errors (failed assignments with their reasons). Required: project_id, employee_ids.

create_a_people_force_time_project

Create a PeopleForce time project. Returns the created project object including its id, name, emoji, project_code, description, and created_at/updated_at timestamps. Required: name.

list_all_people_force_time_projects

List PeopleForce time projects, excluding archived and discarded projects. Returns: id, name, emoji, created_at, updated_at, project_code, description, applicant, pipeline_state.

create_a_people_force_time_projects_time

Create a time project in peopleforce. Returns the created project with id, name, emoji, created_at, updated_at, project_code, and description. Required: name.

list_all_people_force_time_projects_time

List time projects in peopleforce. Excludes archived and discarded projects. Returns each project with id, name, emoji, created_at, updated_at, project_code, and description.

people_force_time_timesheet_entries_bulk_create

Bulk create timesheet entries in PeopleForce for one or more employees. Returns a records block with count and created entries (employee_id, project_id, timesheet_entry_id) plus an errors block. Required: data. Each data item carries employee_id and entries (starts_at, ends_at) for that employee.

people_force_time_timesheet_entries_bulk_delete

Bulk delete PeopleForce timesheet entries matching the given employee, project, entry id, time-range, and type filters. Returns the number of deleted entries as count. Required: employee_ids.

create_a_people_force_time_timesheet_entry

Create a PeopleForce timesheet entry for an employee. Returns the created entry with id, employee_id, project_id, starts_at, ends_at, date, minutes, type, and comment. Required: employee_id, starts_at, ends_at, comment.

delete_a_people_force_time_timesheet_entry_by_id

Delete a PeopleForce timesheet entry by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_time_timesheet_entries

List PeopleForce timesheet entries within a date range, filterable by employee, department, division, location, position, project, team, status, and type. Returns: id, applicant, pipeline_state, created_at, updated_at. Required: starts_on, ends_on.

people_force_time_timesheet_entries_bulk_bulk_delete

Bulk delete timesheet entries in PeopleForce for the specified employees, destroying matching entries in the given range. Returns: count, data. Required: employee_ids.

create_a_people_force_time_timesheet_entries_bulk

Bulk create timesheet entries in PeopleForce for one or more employees. Returns a records block with count and created entries (employee_id, project_id, timesheet_entry_id) plus an errors block. Required: data. Each data item carries employee_id and entries (starts_at, ends_at) for that employee.

create_a_people_force_time_timesheet_entries_time

Create a timesheet entry in PeopleForce to record an employee's tracked time. Returns the created entry including id, employee_id, project_id, starts_at, ends_at, date, minutes, type, and comment. Requires employee_id, starts_at, and ends_at.

delete_a_people_force_time_timesheet_entries_time_by_id

Delete a PeopleForce timesheet entry by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_time_timesheet_entries_time

List timesheet entries in PeopleForce filtered by a required date range plus optional employee, project, department, division, location, position, and team. Returns entries with id, employee_id, project_id, starts_at, date, minutes, and comment. Required: starts_on, ends_on.

list_all_people_force_time_timesheets

List Peopleforce timesheet attendance summaries, with one row per employee covering expected, worked, break, and leave minutes plus the difference between expected and worked time. Returns: employee_number, full_name, email, id, applicant, pipeline_state, created_at, updated_at. All filters are optional: employee_ids, project_ids, month, and year.

list_all_people_force_time_timesheets_time

List timesheets in Peopleforce, filterable by employee, project, month, and year. Returns per-employee timesheet summaries including employee_id, employee_number, full_name, expected_minutes, worked_minutes, break_minutes, and difference_minutes, with pagination metadata.

get_single_people_force_vacancie_pipeline_by_id

Get vacancy pipeline statistics for a specific vacancy in PeopleForce. Returns: data. Required: id.

list_all_people_force_vacancie_pipelines

Get the pipeline summary for a specific vacancy in PeopleForce. Returns: data. Required: vacancy_id.

create_a_people_force_candidate_document

Create a document for a PeopleForce recruitment candidate by uploading a file in a multipart attachment field. Returns: id, filename, created_at, full_name, email, resume, resume_url, applications, custom_fields. Required: candidate_id, attachment.

list_all_people_force_departments_v_4

List all PeopleForce departments. Returns: id, name, parent_id, manager_id, created_at, updated_at, fields, applicant, pipeline_state.

list_all_people_force_divisions_v_4

List PeopleForce divisions. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_document_folder_documents

List documents across employees in one PeopleForce document folder. Returns: id, employee_id, document_folder_id, name, created_at, updated_at, type, url, original_filename, content_type, byte_size, expires_at, applicant, pipeline_state. Download file URLs before their expiry and list the documents again to obtain fresh URLs. Required: document_folder_id.

create_a_people_force_job_level

Create a job level in Peopleforce. Returns the created job level: id, name, created_at, updated_at. Required: name.

delete_a_people_force_job_level_by_id

Delete a job level in Peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_job_levels

List all job levels in Peopleforce. Returns each job level with id, name, created_at, and updated_at.

update_a_people_force_job_level_by_id

Update a job level in Peopleforce by id. Returns the updated job level: id, name, created_at, updated_at. Required: id, name.

create_a_people_force_job_title

Create a job title in peopleforce. Returns: id, name, applicant, pipeline_state, created_at, updated_at. Required: name.

delete_a_people_force_job_title_by_id

Delete a job title in peopleforce by id. Returns an empty 204 response on success.

list_all_people_force_job_titles

List all job titles in peopleforce. Returns: id, name, applicant, pipeline_state, created_at, updated_at.

update_a_people_force_job_title_by_id

Update a job title in peopleforce by id. Returns: id, name, applicant, pipeline_state, created_at, updated_at. Required: id, name.

list_all_people_force_locations_v_4

List all locations in Peopleforce. Returns each location's id, name, country_code, address, time_zone, holiday_policy_id, created_at, and updated_at.

create_a_people_force_people

Create a person in PeopleForce. Returns the created person including id, employee_number, full_name, email, department, and hired_on. Requires first_name and last_name.

get_single_people_force_people_by_id

Get a single person in PeopleForce by id. Returns: id, employee_number, full_name, first_name, last_name, avatar_url, email, personal_email, work_phone_number, mobile_number, date_of_birth, probation_ends_on, hired_on, gender, position, location, employment_type, division, department, reporting_to, created_at, updated_at, applicant, pipeline_state. Required: id.

list_all_people_force_peoples

List all people in PeopleForce. Supports filtering by ids, emails, person_numbers, manager_id, legal_entity_id, and status. Returns: id, employee_number, full_name, first_name, last_name, avatar_url, email, personal_email, work_phone_number, mobile_number, date_of_birth, probation_ends_on, hired_on, gender, position, location, employment_type, division, department, reporting_to, created_at,…

people_force_peoples_activate

Activate a person in PeopleForce by id. Returns the activated person including id, status, employee_number, full_name, email, and department. Required: people_id.

update_a_people_force_people_by_id

Update a person in PeopleForce by id. Returns the updated person including id, status, employee_number, full_name, email, and hired_on. Required: id.

create_a_people_force_planning_position

Create a headcount planning position in Peopleforce. Returns the created position with its id, job_profile (id and name), and status. Required: job_profile_id, status.

delete_a_people_force_planning_position_by_id

Delete a headcount planning position in Peopleforce by id. Returns an empty 204 response on success. Required: id.

list_all_people_force_planning_positions

List a Peopleforce tenant's headcount planning positions. Returns each position's id, job_profile (id and name), and status.

update_a_people_force_planning_position_by_id

Update a headcount planning position in Peopleforce by id. Returns the updated position with its id, job_profile (id and name), and status. Required: id, status.

list_all_people_force_public_legal_entities

List the tenant's legal entities in peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_recruitment_movements

List pipeline-stage movements of vacancy applications in Peopleforce. Returns movement records including vacancy_application (id, applicant_id, vacancy_id), stage, created_by, entered_at, exited_at, duration, and created_at.

list_all_people_force_reports_people_data_changes

List people data changes from PeopleForce, returning each change with its id, employee, changed_by, group, field, value, previous_value, effective_on, and created_at. Filter by employee_ids, changed_by_ids, record_types, date ranges, or a free-text query; salary, additional compensation and pay rate changes are omitted unless the API key has the compensation permission. Defaults: sort=created_at,…

create_a_people_force_table_row

Create a row in a PeopleForce employee's custom table, storing the table's column values keyed by column id. Returns the created row's id. Required: employee_id, table_id, notes, device_type.

delete_a_people_force_table_row_by_id

Delete a row from a PeopleForce employee's custom table. The row is soft-deleted. Returns an empty 204 response on success. Required: employee_id, table_id, id.

update_a_people_force_table_row_by_id

Update a row in a PeopleForce employee's custom table by id. Returns the updated row's id. Required: employee_id, table_id, id, notes.

create_a_people_force_time_overtime_request

Create a PeopleForce overtime request for an employee on a given date. Returns the created request including id, date, starts_at, ends_at, minutes, comment, state, employee, project, created_at, and updated_at. Requires employee_id, date, starts_at, ends_at, and comment.

delete_a_people_force_time_overtime_request_by_id

Delete a PeopleForce overtime request by id. The request is soft-deleted rather than permanently removed. Returns an empty 204 response on success. Required: id.

get_single_people_force_time_overtime_request_by_id

Get a single PeopleForce overtime request by id. Returns the full request including id, date, starts_at, ends_at, minutes, comment, state, employee, project, created_at, and updated_at. Required: id.

list_all_people_force_time_overtime_requests

List PeopleForce overtime requests, filterable by date range, employees, and states. Returns each request with id, date, starts_at, ends_at, minutes, comment, state, employee, project, created_at, and updated_at.

update_a_people_force_time_overtime_request_by_id

Update a PeopleForce overtime request by id; changing starts_at or ends_at recalculates the overtime minutes. Returns the updated request including id, date, starts_at, ends_at, minutes, comment, state, employee, project, created_at, and updated_at. Required: id.

create_a_people_force_work_type

Create a new work type in PeopleForce. Returns the created work type with its id and name. Required: name.

delete_a_people_force_work_type_by_id

Delete a PeopleForce work type by id. Returns an empty 204 response on success.

get_single_people_force_work_type_by_id

Get a single PeopleForce work type by id. Returns: id, name, applicant, pipeline_state, created_at, updated_at. Required: id (integer work type ID).

list_all_people_force_work_types

List all PeopleForce work types. Returns a list of work types, each with: id, name. Pagination is handled automatically.

update_a_people_force_work_type_by_id

Update a PeopleForce work type by id. Returns the updated work type: id, name. Required: id, name.

list_all_people_force_assets

List a person's assets in PeopleForce. Returns: id, name, applicant, pipeline_state, created_at, updated_at. Required: people_id.

list_all_people_force_careers_employment_types

List employment types available in PeopleForce careers. Returns: id, name, applicant, pipeline_state, created_at, updated_at.

list_all_people_force_careers_locations

List PeopleForce career locations. Returns: id, name, applicant, pipeline_state, created_at, updated_at.

get_single_people_force_careers_vacancy_by_id

Get a single careers vacancy in PeopleForce by id. Returns: id, title, description, department, location, employment_type, apply_url, applicant, pipeline_state, created_at, updated_at. Required: id.

list_all_people_force_careers_vacancies

List open careers vacancies in PeopleForce. Returns each vacancy with id, title, description, department, location, employment_type, and apply_url. Supports filtering by title, location_ids, and employment_type_ids.

list_all_people_force_leave_balances

List all leave balances in Peopleforce for every person the service account can see. Returns: id, applicant, pipeline_state, created_at, updated_at.

list_all_people_force_leave_requests

List leave requests in PeopleForce for every person the service account can see. Returns: id, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_lifecycles

List lifecycle records for a PeopleForce person, covering hire and termination details. Returns: id, termination_comment, created_at, updated_at, applicant, pipeline_state. Required: person_id.

people_force_avatars_bulk_update

Update a person's avatar in PeopleForce. Returns the updated person record including id, employment_type, position, and department. Required: people_id and avatar (Base64-encoded data URL image).

delete_a_people_force_compensation_salary_by_id

Delete a salary record for a person in peopleforce. Returns an empty 204 response on success. Required: id, person_id.

get_single_people_force_compensation_salary_by_id

Get a single salary record for a person in peopleforce. Returns: id, effective_on, amount, currency_code, per, comment, created_at, updated_at, custom_fields, applicant, pipeline_state. Required: id, person_id.

list_all_people_force_compensation_salaries

List all salary records for a person in peopleforce. Returns records with id, effective_on, amount, currency_code, per, comment, created_at, updated_at, and custom_fields. Required: person_id.

update_a_people_force_compensation_salary_by_id

Update a salary record for a person in peopleforce. Returns the updated record with id, effective_on, amount, currency_code, per, comment, created_at, updated_at, and custom_fields. Required: id, person_id.

get_compliance_compliance_case_document_by_id

Get a single compliance case document in Peopleforce by id. Returns: id, created_at, updated_at, applicant, pipeline_state. Required: id.

list_all_people_force_compliance_compliance_case_documents

List all compliance case documents in Peopleforce. Returns each document's id, compliance_case_id, employee_id, status, verified_at, attachment, pending_upload, created_at, and updated_at.

people_force_compliance_compliance_case_documents_update_attach

Attach a file to a compliance case document in Peopleforce. Returns the updated document's id, compliance_case_id, employee_id, status, verified_at, attachment, pending_upload, created_at, and updated_at. Required: compliance_case_document_id, attachment.

get_single_people_force_compliance_compliance_case_by_id

Get a single PeopleForce compliance case by id. Returns: id, created_at, updated_at, applicant, pipeline_state. Required: id.

list_all_people_force_compliance_compliance_cases

List PeopleForce compliance cases. Returns: id, created_at, updated_at, applicant, pipeline_state.

get_single_people_force_perform_objective_by_id

Get a single PeopleForce objective by id. Returns the objective with id, title, type, state, progress_percentage, status, key_results, owner, and created_at/updated_at timestamps. Required: id.

list_all_people_force_perform_objectives

List PeopleForce objectives, filterable by status, state, objective type, owner, tag, team, department, division, location, and start/end/updated date ranges. Returns objectives with id, title, type, state, progress_percentage, status, key_results, owner, and created_at/updated_at timestamps.

list_all_people_force_perform_review_cycles

List all review cycles in Peopleforce. Returns: id, name, created_at, updated_at, applicant, pipeline_state. Optionally filter by review_cycle_type (manual, lifecycle) and starts_on/ends_on date ranges.

list_all_people_force_perform_review_responses

List all review responses in Peopleforce. Returns: id, type, created_at, updated_at, applicant, pipeline_state. Optional filters: review_cycle_ids, review_ids, reviewee_ids, review_cycle_type, and created_at/updated_at ranges.

list_all_people_force_pulse_engagement_survey_responses

List PeopleForce engagement survey responses, filterable by survey IDs, employee IDs, custom fields, and created/updated timestamps. Returns: id, position, location, division, department, gender, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_pulse_engagement_surveys

List all engagement surveys in Peopleforce. Returns: id, name, status, anonymous, starts_at, ends_at, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_pulse_lifecycle_survey_responses

List lifecycle survey responses in peopleforce. Returns each response with id, survey_id, user_id, anonymous, status, finished_at, created_at, and answers (question, value, comment).

list_all_people_force_pulse_lifecycle_surveys

List all lifecycle surveys in Peopleforce, optionally filtered by survey status and creation date range. Returns: id, name, anonymous, status, created_at, updated_at, applicant, pipeline_state.

list_all_people_force_people_anniversaries

List work anniversaries for people in PeopleForce. Returns records with id, employee_number, full_name, email, hired_on, position, department, and reporting_to. When no date range is supplied, results default to a window from today (date[gte]) to 30 days out (date[lte]).

list_all_people_force_people_birthdays

List birthdays for people in Peopleforce. Returns: id, status, access, employee_number, full_name, first_name, middle_name, last_name, avatar_url, email, personal_email, work_phone_number, mobile_number, date_of_birth, probation_ends_on, hired_on, gender, position, job_level, location, employment_type, division, department, reporting_to, job_profile, legal_entity, created_at, updated_at,…

list_all_people_force_people_terminateds

List all terminated people in Peopleforce. Returns each record's id, employee_number, full_name, email, hired_on, position, department, and termination details (termination_effective_on, termination_type, termination_reason). Filter by date range using the terminated_on[gt], terminated_on[gte], terminated_on[lt], and terminated_on[lte] filters.

create_a_people_force_terminate

Terminate a person in Peopleforce, ending their employment record. Returns the terminated employee with id, status, employee_number, hired_on, termination_type, termination_reason, and termination_effective_on. Requires people_id, termination_type_id, termination_reason_id, effective_from, and eligible_for_rehire.