PeopleForce

All-in-one HR platform for people operations.

8 triggers17 searches38 actionsPollingAuth: API key

AI-assisted documentation24 min read

This documentation is compiled from our integration source code, internal specs for PeopleForce, its official API documentation and anonymized requests logs we collect from our support team[2].

Open PeopleForce on WEXTL →

Requirements

Connecting PeopleForce takes an active account plus an API access token from your account settings — no other setup is required.[3]

Get your PeopleForce credentials

API KeypasswordRequired
Enter your API key. You can generate it in PeopleForce under Settings → Open API keys (bottom of the page) → Generate API key.
[1]

Connect PeopleForce in WEXTL

Log in to your WEXTL account, add the PeopleForce node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your PeopleForce account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting PeopleForce to WEXTL® — Video slide demonstrates how to integrate PeopleForce in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate PeopleForce in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

PeopleForce node modules

The list below is a reference of every PeopleForce node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any PeopleForce node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch CandidatesTrigger

Output fields[3]

Field	Type
Candidate ID	text
Full name	text
Email	email
Phone numbers	array
Date of birth	date
Position	text
Urls	array
Skills	array
Location	text
Created at	date
Updated at	date
Gender	text
Source	text
Level	text
Desired salary	number
Currency code	text
Last contacted at	text
Cover letter	text
Resume	boolean

4other output fields

Watch EmployeesTrigger

Output fields[3]

Field	Type
Employee ID	number
Active	boolean
Access	boolean
Full name	text
First name	text
Middle name	text
Last name	text
Email	email
Personal email	email
Mobile number	text
Work phone number	text
Date of birth	text
Gender	text
Avatar URL	url
Probation ends on	text
Hired on	date
Skype username	text
Slack username	text
Twitter username	text

9other output fields

Watch Leave RequestsTrigger

Output fields[3]

Field	Type
Leave Request ID	number
Employee ID	number
Employee	object
ID	number
First name	text
Last name	text
Email	email
Leave type ID	number
Leave type	text
State	text
Amount	number
On demand	boolean
Ends on	date
Starts on	date
Comment	text
Attachment URL	url
Attachments	array
Entries	array
Approvals	array
Leave type policy	object
Name	text
Created at	date
Updated at	date

Watch Pay SchedulesTrigger

Output fields[3]

Field	Type
Pay Schedule ID	number
Name	text
Created at	date
Updated at	date

Watch PositionsTrigger

Output fields[3]

Field	Type
Position ID	number
Name	text

Watch TasksTrigger

Output fields[3]

Field	Type
Task ID	number
Title	text
Starts on	email
Ends on	email
Description	text
Description plain	text
Completed at	date
Completed	boolean
Associated to	object
ID	number
Type	text
Full name	text
Email	text
Assigned to	object
ID	number
Full name	text
Email	email
Created by	object
ID	number
Full name	text
Email	email
Created at	date
Updated at	date

Watch TeamsTrigger

Output fields[3]

Field	Type
Team ID	number
Name	text
Description	text
Created at	date
Updated at	date
Team lead	object
ID	number
Full name	text
Email	email
Team members	array

Watch Timesheet EntriesTrigger

Output fields[3]

Field	Type
Timesheet Entry ID	number
Employee ID	number
Starts at	date
Ends at	date
Date	date
Minutes	number
Project ID	number
Comment	text

Get a CandidateAction

Input fields[3]

Field	Type
CandidateRequired	choice

Output fields[3]

Field	Type
Candidate ID	text
Full name	text
Email	email
Phone numbers	array
Date of birth	date
Position	text
Urls	array
Skills	array
Location	text
Created at	date
Updated at	date
Gender	text
Source	text
Level	text
Desired salary	number
Currency code	text
Last contacted at	text
Cover letter	text
Resume	boolean

4other output fields

Get a Leave RequestAction

Input fields[3]

Field	Type
Leave Request IDRequired	choice

Output fields[3]

Field	Type
Leave Request ID	number
Employee ID	number
Employee	object
ID	number
First name	text
Last name	text
Email	email
Leave type ID	number
Leave type	text
State	text
Amount	number
On demand	boolean
Ends on	date
Starts on	date
Comment	text
Attachment URL	url
Attachments	array
Entries	array
Approvals	array
Leave type policy	object
Name	text
Created at	date
Updated at	date

Get a VacancyAction

Input fields[3]

Field	Type
Vacancy IDRequired	choice

Output fields[3]

Field	Type
Vacancy ID	number
Title	text
Description	text
State	text
Minimum salary	number
Maximum salary	number
Applications count	number
Positions	number
Employment type	object
ID	number
Name	text
Created at	date
Department	object
ID	number
Name	text
Parent ID	number
Manager ID	number
Department level ID	number
Location	object
ID	number
Name	text
Job level	object
ID	number
Name	text
Created at	date
Updated at	date
Hiring lead	object
ID	number
Full name	text
Created at	date
Updated at	date
Opened at	date

Get an EmployeeAction

Input fields[3]

Field	Type
Employee IDRequired	choice

Output fields[3]

Field	Type
Employee ID	number
Active	boolean
Access	boolean
Full name	text
First name	text
Middle name	text
Last name	text
Email	email
Personal email	email
Mobile number	text
Work phone number	text
Date of birth	text
Gender	text
Avatar URL	url
Probation ends on	text
Hired on	date
Skype username	text
Slack username	text
Twitter username	text

9other output fields

Get an Employee DocumentAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Document IDRequired	number

Output fields[3]

Field	Type
Employee Document ID	number
Name	text
Type	text
Document folder ID	number
Created at	date
Updated at	date
URL	url
Expires at	date

List CandidatesSearch

Input fields[3]

Field	Type
Pipeline Stage ID	number
Skills	choice
Vacancy IDs	choice
Email	email
Created At From	date
Created At To	date
Updated At From	date
Updated At To	date
Limit	number

Output fields[3]

Field	Type
Candidate ID	text
Full name	text
Email	email
Phone numbers	array
Date of birth	date
Position	text
Urls	array
Skills	array
Location	text
Created at	date
Updated at	date
Gender	text
Source	text
Level	text
Desired salary	number
Currency code	text
Last contacted at	text
Cover letter	text
Resume	boolean

4other output fields

List Employee DocumentsSearch

Input fields[3]

Field	Type
Employee IDRequired	choice
Document Folder ID	choice
Limit	number

Output fields[3]

Field	Type
Employment Document ID	number
Name	text
Type	text
Document folder ID	number
Created at	date
Updated at	date
URL	url
Expires at	date

List Employee NotesSearch

Input fields[3]

Field	Type
Employee IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Employee Note ID	number
Body	text
Created at	date
Updated at	date

List EmployeesSearch

Input fields[3]

Field	Type
Employee IDs	choice
Emails	array
Employee Numbers	array
Status	choice
Manager ID	number
Hired On (From)	date
Hired On (To)	date
Created At (From)	date
Created At (To)	date
Updated At (From)	date
Updated At (To)	date
Limit	number

Output fields[3]

Field	Type
Employee ID	number
Active	boolean
Access	boolean
Full name	text
First name	text
Middle name	text
Last name	text
Email	email
Personal email	email
Mobile number	text
Work phone number	text
Date of birth	text
Gender	text
Avatar URL	url
Probation ends on	text
Hired on	date
Skype username	text
Slack username	text
Twitter username	text

9other output fields

List Leave RequestsSearch

Input fields[3]

Field	Type
Employee IDs	choice
States	array
Starts On (From)	date
Ends On (To)	date
Created After	date
Created Before	date
Updated After	date
Updated Before	date
Limit	number

Output fields[3]

Field	Type
Leave Request ID	number
Employee ID	number
Employee	object
ID	number
First name	text
Last name	text
Email	email
Leave type ID	number
Leave type	text
State	text
Amount	number
On demand	boolean
Ends on	date
Starts on	date
Comment	text
Attachment URL	url
Attachments	array
Entries	array
Approvals	array
Leave type policy	object
Name	text
Created at	date
Updated at	date

List Pay SchedulesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Pay Schedule ID	number
Name	text
Created at	date
Updated at	date

List Pending Leave RequestsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Leave Request ID	number
Employee ID	number
Employee	object
ID	number
First name	text
Last name	text
Email	email
Leave type ID	number
Leave type	text
State	text
Amount	number
On demand	boolean
Ends on	date
Starts on	date
Comment	text
Attachment URL	url
Attachments	array
Entries	array
Approvals	array
Leave type policy	object
Name	text
Created at	date
Updated at	date

List PositionsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Position ID	number
Name	text

List TasksSearch

Input fields[3]

Field	Type
Completed	boolean
Limit	number

Output fields[3]

Field	Type
Task ID	number
Title	text
Starts on	email
Ends on	email
Description	text
Description plain	text
Completed at	date
Completed	boolean
Associated to	object
ID	number
Type	text
Full name	text
Email	text
Assigned to	object
ID	number
Full name	text
Email	email
Created by	object
ID	number
Full name	text
Email	email
Created at	date
Updated at	date

List TeamsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Team ID	number
Name	text
Description	text
Created at	date
Updated at	date
Team lead	object
ID	number
Full name	text
Email	email
Team members	array

List Timesheet EntriesSearch

Input fields[3]

Field	Type
Starts On	date
Ends On	date
Employee IDs	choice
Position IDs	choice
Team IDs	array
Department IDs	choice
Location IDs	choice
Division IDs	choice
Type	choice
Project IDs	choice
Status	choice
Limit	number

Output fields[3]

Field	Type
Timesheet Entry ID	number
Employee ID	number
Starts at	date
Ends at	date
Date	date
Minutes	number
Project ID	number
Comment	text

List VacanciesSearch

Input fields[3]

Field	Type
Status	choice
Tag IDs	array
Limit	number

Output fields[3]

Field	Type
Vacancy ID	number
Title	text
Description	text
State	text
Minimum salary	number
Maximum salary	number
Applications count	number
Positions	number
Employment type	object
ID	number
Name	text
Created at	date
Department	object
ID	number
Name	text
Parent ID	number
Manager ID	number
Department level ID	number
Location	object
ID	number
Name	text
Job level	object
ID	number
Name	text
Created at	date
Updated at	date
Hiring lead	object
ID	number
Full name	text
Created at	date
Updated at	date
Opened at	date

Activate an EmployeeAction

Input fields[3]

Field	Type
Employee IDRequired	choice

Output fields[3]

Field	Type
Employee ID	number
Access	boolean
Full name	text
First name	text
Middle name	text
Last name	text
Avatar URL	url
Email	email
Personal email	email
Date of birth	date
Hired on	date
Probation ends on	date
Gender	object
ID	text
Name	text
Position	object
ID	number
Name	text
Job level	object
ID	number
Name	text
Created at	date
Updated at	date
Location	object
ID	number
Name	text
Employment type	object
ID	number
Name	text
Created at	date
Division	object
ID	number
Name	text
Department	object
ID	number
Name	text
Parent ID	number
Manager ID	number
Department level ID	number

10other output fields

Assign a Leave PolicyAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Leave Type IDRequired	choice
Leave Policy IDRequired	choice
Effective On	date

Output fields[3]

Field	Type
Effective on	date
Balance	number
Leave type policy	object
ID	number
Name	text
Leave type ID	number
Visibility	boolean
Created at	date
Updated at	date
Leave type	object
ID	number
Name	text
Unit	text
Hex color	text
Fa class	text
Created at	date
ID	number
Created at	date
Updated at	date

Complete a TaskAction

Input fields[3]

Field	Type
Task IDRequired	choice

Create a CandidateAction

Input fields[3]

Field	Type
Full NameRequired	text
Email	text
Date of Birth	date
Position	text
Resume	file
Source ID	choice
Location	choice
Phone Numbers	array
Skills	choice
URLs	array
Telegram Username	text
Cover Letter	text
Custom Fields	array

Output fields[3]

Field	Type
Candidate ID	text
Full name	text
Email	email
Phone numbers	array
Date of birth	date
Position	text
Urls	array
Skills	array
Location	text
Created at	date
Updated at	date
Gender	text
Source	text
Level	text
Desired salary	number
Currency code	text
Last contacted at	text
Cover letter	text
Resume	boolean

6other output fields

Create a Leave RequestAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Leave Type IDRequired	choice
Starts OnRequired	date
Ends OnRequired	date
Description	text
Skip Approval	boolean
Leave Request Entries	array

Output fields[3]

Field	Type
Leave Request ID	number
Employee ID	number
Employee	object
ID	number
First name	text
Last name	text
Email	email
Leave type ID	number
Leave type	text
State	text
Amount	number
On demand	boolean
Ends on	date
Starts on	date
Comment	text
Attachment URL	url
Attachments	array
Entries	array
Approvals	array
Leave type policy	object
Name	text
Created at	date
Updated at	date

Create a PositionAction

Input fields[3]

Field	Type
NameRequired	text

Output fields[3]

Field	Type
Position ID	number
Name	text

Create a ProjectAction

Input fields[3]

Field	Type
NameRequired	text
EmojiRequired	text

Output fields[3]

Field	Type
Project ID	number
Name	text
Emoji	text
Created at	date
Updated at	date

Create a TaskAction

Input fields[3]

Field	Type
Task NameRequired	text
Employee IDRequired	choice
Description	text
Starts On	date
Ends On	date

Output fields[3]

Field	Type
Task ID	number
Title	text
Starts on	date
Ends on	date
Description	text
Description plain	text
Completed at	date
Completed	boolean
Associated to	object
ID	number
Type	text
Full name	text
Email	text
Assigned to	object
ID	number
Full name	text
Email	email
Created by	object
ID	number
Full name	text
Email	text
Created at	date
Updated at	date

Create a TeamAction

Input fields[3]

Field	Type
NameRequired	text
Team Lead IDRequired	number
Description	text
User IDs	array

Create a Team MemberAction

Input fields[3]

Field	Type
Team IDRequired	choice
User IDRequired	number

Output fields[3]

Field	Type
ID	number
Team ID	number
User ID	number
Created at	date
Updated at	date

Create a Timesheet EntryAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Start TimeRequired	date
End TimeRequired	date
Project ID	choice
Comment	text

Output fields[3]

Field	Type
Timesheet Entry ID	number
Employee ID	number
Starts at	date
Ends at	date
Date	text
Minutes	number
Project ID	number
Comment	text

Create an EmployeeAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
Middle Name	text
Employee Number	text
Work Email	email
Personal Email	email
Mobile Number	text
Work Phone Number	text
Date of Birth	date
Hired On	date
Gender	choice
Job Profile ID	choice
Custom Fields	array

Output fields[3]

Field	Type
Employee ID	number
Access	boolean
Full name	text
First name	text
Middle name	text
Last name	text
Avatar URL	url
Email	email
Personal email	text
Date of birth	text
Hired on	text
Probation ends on	text
Gender	object
ID	text
Name	text
Position	object
ID	number
Name	text
Job level	object
ID	number
Name	text
Created at	date
Updated at	date
Location	object
ID	number
Name	text
Employment type	object
ID	number
Name	text
Created at	date
Division	object
ID	number
Name	text
Department	object
ID	number
Name	text
Parent ID	number
Manager ID	number
Department level ID	number

10other output fields

Create an Employee DocumentAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Document FolderRequired	choice
Document NameRequired	text
Document SourceRequired	choice

Output fields[3]

Field	Type
Employee Document ID	number
Name	text
Type	text
Document folder ID	number
Created at	date
Updated at	date
URL	url
Expires at	date

Create an Employee Employment StatusAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Effective FromRequired	date
Working Pattern ID	choice
Probation Policy ID	choice
Employment Type ID	choice
Comment	text

Output fields[3]

Field	Type
Employee Employment Status ID	number
Effective from	date
Employment type	object
ID	number
Name	text
Created at	date
Probation policy	object
ID	number
Name	text
Length	number
Created at	date
Updated at	date
Working pattern	object
ID	number
Name	text
Monday hours	text
Tuesday hours	text
Wednesday hours	text
Thursday hours	text
Friday hours	text
Saturday hours	text
Sunday hours	text
Created at	date
Comment	text
Created at	date
Updated at	date

Create an Employee PositionAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Effective FromRequired	date
Position	choice
Location	choice
Division ID	choice
Department ID	choice
Reporting To ID	number
Job Level ID	choice

Output fields[3]

Field	Type
Employee Position ID	text
Effective on	date
Position	object
ID	number
Name	text
Location	object
ID	number
Name	text
Division	object
ID	number
Name	text
Department	object
ID	number
Name	text
Parent ID	number
Manager ID	number
Department level ID	number
Reporting to	object
ID	number
First name	text
Last name	text
Email	email
Job level	object
ID	number
Name	text
Created at	date
Updated at	text

Create an Employee SkillAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Skill IDRequired	choice
Skill LevelRequired	choice

Create Employee Additional CompensationAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Compensation Type IDRequired	choice
AmountRequired	number
Starts OnRequired	date
Currency CodeRequired	text
Compensation TypeRequired	choice

Output fields[3]

Field	Type
Employee Additional Compensation ID	number
Compensation type	object
ID	number
Name	text
Type	text
Description	text
Frequency	text
Amount	text
Currency code	text
Starts on	text
Ends on	text
Created at	date
Updated at	date

Create Employee NoteAction

Input fields[3]

Field	Type
Employee IDRequired	choice
NoteRequired	text
Created By ID	number

Output fields[3]

Field	Type
Employee Note ID	number
Body	text
Created at	date
Updated at	date
Author	object
ID	number
First name	text
Last name	text
Email	email

Create Employee SalaryAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Effective OnRequired	date
AmountRequired	number
Pay PeriodRequired	choice
Currency CodeRequired	text
Overtime Eligible	boolean
Comment	text
Pay Schedule ID	choice

Output fields[3]

Field	Type
Employee Salary ID	number
Effective on	date
Currency code	text
Amount	number
Per	text
Overtime	boolean
Comment	text
Pay schedule	object
ID	number
Name	text
Created at	date
Updated at	date

Delete a CandidateAction

Input fields[3]

Field	Type
CandidateRequired	choice

Delete a Leave RequestAction

Input fields[3]

Field	Type
Leave Request IDRequired	choice

Delete a PositionAction

Input fields[3]

Field	Type
PositionRequired	choice

Delete a TeamAction

Input fields[3]

Field	Type
Team IDRequired	choice

Delete a Team MemberAction

Input fields[3]

Field	Type
User IDRequired	number

Delete a Timesheet EntryAction

Input fields[3]

Field	Type
Timesheet Entry IDRequired	choice

Delete an Employee DocumentAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Document IDRequired	number

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Mark a Task IncompleteAction

Input fields[3]

Field	Type
Task IDRequired	choice

Terminate an EmployeeAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Effective FromRequired	date
Termination Type IDRequired	choice
Termination Reason IDRequired	choice
Eligible for RehireRequired	boolean
Comment	text

Update a CandidateAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
Full Name	text
Email	text
Phone Numbers	array
Date of Birth	date
Position	text
Resume	file
Source ID	choice
URLs	array
Skills	choice
Location	choice
Skype Username	text
Telegram Username	text
Cover Letter	text

Update a PositionAction

Input fields[3]

Field	Type
PositionRequired	choice
NameRequired	text

Update a TeamAction

Input fields[3]

Field	Type
Team IDRequired	choice
Name	text
Description	text
Team Lead ID	number

Output fields[3]

Field	Type
Team ID	number
Name	text
Description	text
Created at	date
Updated at	date
Team lead	object
ID	number
Full name	text
Email	text
Team members	array

Update an Employee SkillAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Employee Skill IDRequired	choice
Skill LevelRequired	choice

Update EmployeeAction

Input fields[3]

Field	Type
Employee IDRequired	choice
First Name	text
Middle Name	text
Last Name	text
Work Email	email
Personal Email	email
Mobile Number	text
Work Phone Number	text
Employee Number	text
Date of Birth	date
Hired On	date
Gender	choice
Job Profile ID	choice
Custom Fields	array

Update Employee Employment StatusAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Employment Status IDRequired	number
Effective FromRequired	date
Working Pattern ID	choice
Probation Policy ID	choice
Employment Type ID	choice
Comment	text

Output fields[3]

Field	Type
Employment Status ID	number
Effective from	date
Employment type	object
ID	number
Name	text
Created at	date
Probation policy	object
ID	number
Name	text
Length	number
Created at	date
Updated at	date
Working pattern	object
ID	number
Name	text
Monday hours	text
Tuesday hours	text
Wednesday hours	text
Thursday hours	text
Friday hours	text
Saturday hours	text
Sunday hours	text
Created at	date
Comment	text
Created at	date
Updated at	date

Update Employee Leave BalanceAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Leave BalanceRequired	number
Leave Type ID	choice
Employee Leave Type ID	number
On-Demand Leave Balance	number

Update Employee PositionAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Employee Position IDRequired	choice
Effective FromRequired	date
Position ID	choice
Location ID	choice
Department ID	choice
Division ID	choice
Reporting To ID	number
Job Level ID	choice

Output fields[3]

Field	Type
Employee Position ID	text
Effective on	date
Position	object
ID	number
Name	text
Location	object
ID	number
Name	text
Division	object
ID	number
Name	text
Department	object
ID	number
Name	text
Parent ID	number
Manager ID	number
Department level ID	number
Reporting to	object
ID	number
First name	text
Last name	text
Email	text
Job level	object
ID	number
Name	text
Created at	date
Updated at	date

Update Employee SalaryAction

Input fields[3]

Field	Type
Employee IDRequired	choice
Employee Salary IDRequired	number
Effective On	date
Amount	number
Pay Period	choice
Currency Code	text
Overtime Eligible	boolean
Comment	text
Pay Schedule	choice

Output fields[3]

Field	Type
Emloyee Salary ID	number
Effective on	date
Currency code	text
Amount	number
Per	text
Overtime	boolean
Comment	text
Pay schedule	object
ID	number
Name	text
Created at	date
Updated at	date

Templates

Look for PeopleForce templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in HR category →

References

WEXTL® PeopleForce Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for PeopleForce.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.