Requirements
People First requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]
Get your People First credentials
- Access TokenpasswordRequired
Generated in People First: Administration → Settings → Inbound Integration → Generate Access Token. Copy it immediately — it cannot be viewed again after the dialog is dismissed.
[1] - Tenant CodetextRequired
The tenant code provided by MHR (e.g. 'tpruk'). Used in your base URL and as a request header on every API call.
[1] - Environment Codetext
The environment code provided by MHR (e.g. 'dev'). Leave blank if accessing your default/production environment — the hostname segment and header will be omitted automatically.
[1]
Connect People First in WEXTL
- Log in to your WEXTL account, add the People First 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 People First 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 →
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 →
People First node modules
The list below is a reference of every People First node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every People First node module below — each one opens to show its input parameters, outputs, and connection requirements.
Get AbsenceAction
Input fields[3]
| Field | Type |
|---|---|
Absence IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Person ID | text |
| Occupancy ID | text |
| Absence category ID | text |
| Absence type ID | text |
| Start date | text |
| End date | text |
| Start date type ID | text |
| End date type ID | text |
| Expected end date | text |
| Reason ID | text |
| Reason | text |
| Group | text |
| Absence duration unit | text |
| Start day start time | text |
| Start day end time | text |
| Start day time zone | text |
| Start date hours and minutes | text |
16other output fields
Get Absence Approval TemplateAction
Get Absence AttachmentAction
Get Calendar EventsAction
Input fields[3]
| Field | Type |
|---|---|
Event IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Calendar event | object |
| Meta | object |
| Calendar event ID | object |
| Calendar event source ID | object |
| Calendar event employee ID | object |
| Calendar event start date time | object |
| Calendar event end date time | object |
| Calendar event time zone | object |
| Calendar event location | object |
| Calendar event description | object |
| Calendar event user description | object |
| Calendar event type | object |
Get Check-In TypeAction
Get Clock RecordAction
Get Employee ProfileAction
Input fields[3]
| Field | Type |
|---|---|
Employee IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Employee profile | object |
| Meta | object |
| Employee profile ID | object |
| Employee profile type | object |
| Employee profile linked calendar provider ID | object |
| Employee profile linked video profile ids | object |
| Employee profile video conference enabled | object |
| Links | object |
Get Job MembershipAction
Get MembershipAction
Get OccupancyAction
Get Occupancy DateAction
Input fields[3]
| Field | Type |
|---|---|
Occupancy IDRequired | text |
Effective DateRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Meta | object |
| Occupancies expected end date | object |
| Occupancies expected end reason | object |
| Occupancies title | object |
| Occupancies end date | object |
| Occupancies reporting job | object |
| Occupancies reporting unit | object |
| Occupancies reporting person name | object |
| Occupancies reporting manager | object |
| Occupancies reporting manager person ID | object |
| Occupancies job reference number | object |
| Data | object |
| Occupancies | object |
Get PayrollAction
Get PersonAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Person | object |
| Meta | object |
| Person person ID | object |
| Person type | object |
| Person first name | object |
| Person last name | object |
| Person title | object |
| Person other names | object |
| Person known as | object |
| Person previous last name | object |
| Person start date | object |
| Person personal reference | object |
Get Person ContactsAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Personcontacts | object |
| Meta | object |
| Personcontacts ID | object |
| Personcontacts company calling code ID | object |
| Personcontacts company number | object |
| Personcontacts personal calling code ID | object |
| Personcontacts personal number | object |
| Personcontacts personal mobile | object |
| Personcontacts work email | object |
| Personcontacts personal email | object |
| Personcontacts linked in profile | object |
| Personcontacts twitter profile | object |
Get Talking PointAction
List Absence AttachmentsSearch
List Check-In TypesSearch
List Clock RecordsSearch
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
| View Start Date Time | date |
| View End Date Time | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Person ID | text |
| Start timestamp | date |
| Start time zone | time |
| Start longitude | number |
| Start latitude | number |
| Start accuracy | number |
| Start source | text |
| End timestamp | date |
| End time zone | time |
| End longitude | number |
| End latitude | number |
| End accuracy | number |
| End source | text |
| Processing status | number |
| links | object |
| Self | object |
| meta | object |
| Links | object |
List Department EmployeesSearch
List Employee Calendar EventsSearch
Input fields[3]
| Field | Type |
|---|---|
Employee IDRequired | choice |
View Start DateRequired | date |
View End DateRequired | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Source ID | text |
| Employee ID | text |
| Start date time | date |
| End date time | date |
| Time zone | text |
| Location | text |
| Description | text |
| User description | text |
| Type | text |
| Sub type | text |
| State | text |
| All day event | boolean |
| Send to external calendar | boolean |
| Video profile ID | text |
| Video provider name | text |
| Video URL | text |
| links | object |
| Self | object |
| Source | object |
List Job MembershipsSearch
List MembershipsSearch
List PayrollsSearch
Input fields[3]
| Field | Type |
|---|---|
| PAYE Reference | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Legislation ID | text |
| Is complete | boolean |
| To do item count | number |
| Version | number |
| links | object |
| Self | object |
| Legislation | object |
| Schedule | object |
| Company information | object |
| Payroll company bank accounts | object |
| Payroll tax offices | object |
| Payroll banner image template | object |
| Summary | object |
List People Calendar EventsSearch
Input fields[3]
| Field | Type |
|---|---|
Person ID(s)Required | choice |
View Start DateRequired | date |
View End DateRequired | date |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Source ID | text |
| Employee ID | text |
| Start date time | date |
| End date time | date |
| Time zone | time |
| Location | text |
| Description | text |
| User description | text |
| Type | text |
| Sub type | text |
| State | text |
| All day event | boolean |
| Send to external calendar | boolean |
| Video profile ID | text |
| Video provider name | text |
| Video URL | url |
| links | object |
| Self | object |
| Source | object |
List Talking PointsSearch
Search Job VacanciesSearch
Search JobsSearch
Search Skilled EmployeesSearch
Approve AbsenceAction
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| links | object |
Complete PayrollAction
Input fields[3]
| Field | Type |
|---|---|
If-Match (ETag)Required | text |
| Payroll | choice |
| Annotate | text |
| Payroll Name | text |
| Legislation ID | choice |
| Is Complete | boolean |
| To-Do Item Count | number |
| Version | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Legislation ID | text |
| Is complete | boolean |
| To do item count | number |
| Version | number |
| links | object |
| Self | object |
| Legislation | object |
| Schedule | object |
| Company information | object |
| Payroll company bank accounts | object |
| Payroll tax offices | object |
| Payroll banner image template | object |
| Summary | object |
Create Absence AttachmentAction
Create Calendar EventAction
Input fields[3]
| Field | Type |
|---|---|
| Source ID | choice |
| Employee ID | choice |
| Start Date Time | date |
| End Date Time | date |
| Time Zone | time |
| Location | text |
| Description | text |
| User Description | text |
| Type | text |
| Sub Type | text |
| State | text |
| All Day Event | boolean |
| Send to External Calendar | boolean |
| Video Profile ID | choice |
| Annotate | text |
| Video Provider Name | text |
| Video URL | url |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Source ID | text |
| Employee ID | text |
| Start date time | date |
| End date time | date |
| Time zone | text |
| Location | text |
| Description | text |
| User description | text |
| Type | text |
| Sub type | text |
| State | text |
| All day event | boolean |
| Send to external calendar | boolean |
| Video profile ID | text |
| Video provider name | text |
| Video URL | text |
| links | object |
| Self | object |
Create Check-In TypeAction
Create Check-In Type Talking PointAction
Create Clock InAction
Create Clock OutAction
Create Clock RecordAction
Input fields[3]
| Field | Type |
|---|---|
PersonRequired | choice |
| Annotate | text |
Clock RecordRequired | object |
| Clock Record | object |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Person ID | text |
| Start timestamp | date |
| Start time zone | time |
| Start longitude | number |
| Start latitude | number |
| Start accuracy | number |
| Start source | text |
| End timestamp | date |
| End time zone | time |
| End longitude | number |
| End latitude | number |
| End accuracy | number |
| End source | text |
| Processing status | number |
| links | object |
| Self | object |
| Edit | object |
| Delete | object |
Create Job MembershipAction
Create Job TransferAction
Input fields[3]
| Field | Type |
|---|---|
Job IDRequired | choice |
Destination Unit IDRequired | choice |
Transfer DateRequired | text |
| Inherit Annual Weeks Worked | boolean |
| Inherit FTE Hour | boolean |
| Inherit Contractual Hours | boolean |
| Inherit Employment Basis | boolean |
| Inherit Employment Type | boolean |
| Inherit Employment Category | boolean |
| Inherit Term Time Only | boolean |
| Inherit Schemes and Benefits | array |
| Inherit Notice Period | boolean |
| Inherit Probationary Period | boolean |
| Inherit Salary | boolean |
| Inherit Working Pattern | boolean |
| Inherit Location | boolean |
| Source Job ID | text |
| Additional Information | text |
Create MembershipAction
Create Onboarding PersonAction
Input fields[3]
| Field | Type |
|---|---|
| Title ID | choice |
First NameRequired | text |
Last NameRequired | text |
Employment Start DateRequired | text |
Job IDRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Onboarding person | object |
| Meta | object |
| Onboarding person title ID | object |
| Onboarding person first name | object |
| Onboarding person last name | object |
| Onboarding person employment start date date | object |
| Onboarding person job ID | object |
Create PayrollAction
Create PersonAction
Input fields[3]
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
| Title ID | choice |
| Other Names | text |
| Known As | text |
| Pronouns ID | text |
| Previous Last Name | text |
| Start Date | text |
| Personal Reference | text |
| Social Security Numbers | array |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Person | object |
| Meta | object |
| Person person ID | object |
| Person type | object |
| Person first name | object |
| Person last name | object |
| Person title | object |
| Person other names | object |
| Person known as | object |
| Person previous last name | object |
| Person start date | object |
| Person personal reference | object |
Delete AbsenceAction
Input fields[3]
| Field | Type |
|---|---|
Absence IDRequired | choice |
If-Match (ETag)Required | text |
Delete Absence AttachmentAction
Input fields[3]
| Field | Type |
|---|---|
Absence IDRequired | choice |
Attachment IDRequired | choice |
If-Match (ETag)Required | text |
Delete Calendar EventAction
Input fields[3]
| Field | Type |
|---|---|
Event IDRequired | choice |
If-Match (ETag)Required | text |
Delete Check-In Talking PointAction
Input fields[3]
| Field | Type |
|---|---|
Check In TypeRequired | choice |
Talking Point IDRequired | choice |
If-Match (ETag)Required | text |
Delete Check-In TypeAction
Input fields[3]
| Field | Type |
|---|---|
Check In TypeRequired | choice |
If-Match (ETag)Required | text |
Delete Clock RecordsAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
If-Match (ETag)Required | text |
Delete Job MembershipAction
Input fields[3]
| Field | Type |
|---|---|
Job IDRequired | choice |
Job Membership IDRequired | choice |
If-Match (ETag)Required | text |
Delete MembershipAction
Input fields[3]
| Field | Type |
|---|---|
MembershipRequired | choice |
If-Match (ETag)Required | text |
Delete OccupancyAction
Input fields[3]
| Field | Type |
|---|---|
Occupancy IDRequired | choice |
If-Match (ETag)Required | text |
Delete Occupancy Effective DateAction
Input fields[3]
| Field | Type |
|---|---|
Occupancy IDRequired | choice |
Effective DateRequired | text |
If-Match (ETag)Required | text |
Delete PayrollAction
Input fields[3]
| Field | Type |
|---|---|
PayrollRequired | choice |
If-Match (ETag)Required | text |
Delete PersonAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
If-Match (ETag)Required | text |
Make an API Calluniversal
Reject AbsenceAction
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Absences | object |
| Meta | object |
| Links | object |
Update AbsenceAction
Input fields[3]
| Field | Type |
|---|---|
Absence IDRequired | choice |
If-Match (ETag)Required | text |
| Person ID | choice |
| Absence Type ID | choice |
| Start Date | date |
| End Date | date |
| Start Date Type ID | text |
| End Date Type ID | text |
| Expected End Date | date |
| Reason ID | text |
| Reason | text |
| Group | text |
| Absence Duration Unit | choice |
| Start Day Start Time | date |
| Start Day End Time | date |
| Start Time Zone | time |
| Start Date Hours and Minutes | date |
| End Day Start Time | text |
7other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Person ID | text |
| Occupancy ID | text |
| Absence category ID | text |
| Absence type ID | text |
| Start date | text |
| End date | text |
| Start date type ID | text |
| End date type ID | text |
| Expected end date | text |
| Reason ID | text |
| Reason | text |
| Group | text |
| Absence duration unit | text |
| Start day start time | text |
| Start day end time | text |
| Start day time zone | text |
| Start date hours and minutes | text |
16other output fields
Update Absence AttachmentAction
Input fields[3]
| Field | Type |
|---|---|
Absence IDRequired | choice |
User IDRequired | number |
| If-Match (ETag) | text |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Attachments | object |
| Meta | object |
| Attachment ID | object |
| Attachment type | object |
| Attachment file date | object |
| Attachment document name | object |
| Attachment author ID | object |
| Attachment file name | object |
| Links | object |
Update Calendar EventAction
Input fields[3]
| Field | Type |
|---|---|
Event IDRequired | choice |
If-Match (ETag)Required | text |
| Source ID | text |
| Employee ID | choice |
| Start Date Time | date |
| End Date Time | date |
| Time Zone | time |
| Location | text |
| Description | text |
| User Description | text |
| Type | text |
| Sub Type | text |
| State | text |
| All Day Event | boolean |
| Send to External Calendar | boolean |
| Video Profile ID | text |
| Video Provider Name | text |
| Video URL | url |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Source ID | text |
| Employee ID | text |
| Start date time | date |
| End date time | date |
| Time zone | text |
| Location | text |
| Description | text |
| User description | text |
| Type | text |
| Sub type | text |
| State | text |
| All day event | boolean |
| Send to external calendar | boolean |
| Video profile ID | text |
| Video provider name | text |
| Video URL | text |
| links | object |
| Self | object |
Update Check-In TypeAction
Input fields[3]
| Field | Type |
|---|---|
Check In TypeRequired | choice |
If-Match (ETag)Required | text |
NameRequired | text |
| Employee Manager Type | text |
| Active | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Check in type | object |
| Meta | object |
| Check in type ID | object |
| Check in type type | object |
| Check in type name | object |
| Check in type employee manager type | object |
| Check in type active | object |
| Links | object |
Update Clock RecordAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
If-Match (ETag)Required | text |
| Start Timestamp | date |
| Start Time Zone | text |
| Start Source | text |
| Start Longitude | number |
| Start Latitude | number |
| Start Accuracy | number |
| End Timestamp | date |
| End Time Zone | text |
| End Source | text |
| End Longitude | number |
| End Latitude | number |
| End Accuracy | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Person ID | text |
| Start timestamp | date |
| Start time zone | time |
| Start longitude | number |
| Start latitude | number |
| Start accuracy | number |
| Start source | text |
| End timestamp | date |
| End time zone | time |
| End longitude | number |
| End latitude | number |
| End accuracy | number |
| End source | text |
| Processing status | number |
| links | object |
| Self | object |
| Edit | object |
| Delete | object |
Update Job MembershipAction
Update MembershipAction
Update OccupancyAction
Input fields[3]
| Field | Type |
|---|---|
Occupancy IDRequired | choice |
If-Match (ETag)Required | text |
| Reporting Job | text |
| Reporting Job ID | choice |
| Reporting Manager | text |
| Reporting Manager Person ID | text |
| Person Name | text |
| Reporting Unit | text |
| Reporting Unit ID | text |
| Revision Start Date | text |
| Revision End Date | text |
| Job Reference Number | text |
| Contractual Hours | text |
| Is Key Job | boolean |
| Person ID | choice |
| Structure ID | text |
| Occupancy Title | text |
| Start Date | text |
7other input fields
Output fields[3]
| Field | Type |
|---|---|
| Meta | object |
| Occupancies location | object |
| Links | object |
| Data | object |
| Occupancies | object |
Update PayrollAction
Update PersonAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
If-Match (ETag)Required | text |
| First Name | text |
| Last Name | text |
| Title ID | text |
| Other Names | text |
| Known As | text |
| Pronouns ID | text |
| Previous Last Name | text |
| Start Date | text |
| Personal Reference | text |
| Social Security Numbers | array |
Update Person ContactsAction
Input fields[3]
| Field | Type |
|---|---|
Person IDRequired | choice |
If-Match (ETag)Required | text |
| Company Calling Code ID | text |
| Company Number | text |
| Personal Calling Code ID | text |
| Personal Number | text |
| Personal Mobile | text |
| Work Email | |
| Personal Email | |
| LinkedIn Profile | url |
| Twitter Profile | url |
| Skype Profile | text |
Output fields[3]
| Field | Type |
|---|---|
| Data | object |
| Personcontacts | object |
| Meta | object |
| Personcontacts ID | object |
| Personcontacts company calling code ID | object |
| Personcontacts company number | object |
| Personcontacts personal calling code ID | object |
| Personcontacts personal number | object |
| Personcontacts personal mobile | object |
| Personcontacts work email | object |
| Personcontacts personal email | object |
| Personcontacts linked in profile | object |
| Personcontacts twitter profile | object |
Templates
Look for People First templates in the WEXTL template library.
Browse templates →Explore alternative apps
- BrioHR[2]HR management platform for employee data, leave, payroll-ready records, and people operations.
- BuddyPunchEmployee time clock and attendance tracking for hourly teams.
- Breathe HRCloud HR software for employee records, leave, onboarding, and people management.
- Base.vnWorkplace suite for HR, requests, meetings, time off, and team operations.
- CalamariHR leave, attendance, and timesheet management for growing teams.
References
- WEXTL® People First Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for People First.
- WEXTL® visual workflow builder data.
Last updated: Jul 21, 2026 15:23