Articles in this section

Available ADP Workforce Now APIs

When you configure an export, import, or other type of flow step using the prebuilt ADP Workforce Now connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the ADP Workforce Now API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Benefits: Beneficiaries

Get the list of all available beneficiaries

X

Benefits: Benefit dependents

Get the list of all available dependents

X

Benefits: External benefit plans

Create benefit plans

X

Confirm external benefit plan data

X

Custom fields

Change the worker person custom field amount

X

Change the worker person custom field code

X

Change the worker person custom field date

X

Change the worker person custom field indicator

X

Change the worker person custom field number

X

Change the worker person custom field percentage

X

Change the worker person custom field string

X

Change the worker person custom field telephone

X

Change the worker custom field amount

X

Change the worker custom field code

X

Change the worker custom field date

X

Change the worker custom field indicator

X

Change the worker custom field number

X

Change the worker custom field percentage

X

Change the worker custom field string

X

Change the worker custom field telephone

X

Event notifications

Get all event notifications

X

HCM: Applicant onboarding

Get applicant onboard metadata for US client

X

Get applicant onboard metadata for Canada client

X

Get applicant onboard metadata for international client

X

Applicant onboarding request for US client

X

Applicant onboarding request for Canada client

X

Applicant onboarding request for international client

X

HCM: Client data: Validation tables

Add new code to a validation table: Associate work locations

X

List of items in validation table: Associate work locations

X

Add new code to a validation table: Business units

X

List of items in validation table: Business units

X

Add new code to a validation table: Cost centers

X

List of items in validation table: Cost centers

X

Add new code to a validation table: Departments

X

List of items in validation table: Departments

X

Get details of a specific record in the validation table: Jobs

X

Add new code to a validation table: Jobs

X

Get a meta for jobs

X

Get a meta for validation tables

X

Get details of a specific record in the custom fields: Person custom fields

X

List of items in person custom fields: Person custom fields

X

List of items in worker custom fields: Worker custom fields

X

Get details of a specific record in the custom fields

X

HCM: WFN custom codelists

Get the list of all available codes duirng the payroll instruction management in WFN (v4)

X

Get the list of all available codes duirng the payroll instruction management in WFN (v3)

X

Get the list of all available codes duirng the worker management in WFN (v4)

X

Get the list of all available codes duirng the worker management in WFN (v3)

X

HR: Corporate directory

Get an image of a contact

X

HR: Personal contact

Get personal contacts for a worker

X

Get a specific personal contact for a worker

X

Add home phone

X

Change home phone

X

Remove home phone

X

Add personal email

X

Change personal email

X

Remove personal email

X

Add legal address

X

Change legal address

X

Remove legal address

X

Add primary address

X

Change primary address

X

Remove primary address

X

Change birth date

X

Change education level

X

Change gender

X

Change marital status

X

Change race code

X

Change maiden name

X

Change name

X

Add tax ID

X

Change tax ID

X

Add personal fax

X

Change personal fax

X

Remove personal fax

X

Add personal mobile

X

Change personal mobile

X

Remove personal mobile

X

Add personal pager

X

Change personal pager

X

Remove personal pager

X

Add work cell

X

Change work cell

X

Remove work cell

X

Add work email

X

Change work email

X

Remove work email

X

Add work fax

X

Change work fax

X

Remove work fax

X

Add work pager

X

Change work pager

X

Remove work pager

X

Add work phone

X

Change work phone

X

Remove work phone

X

Add worker personal contact

X

Update an existing personal contact

X

Remove a personal contact

X

Get worker personal contact add event metadata

X

Get worker personal contact change event metadata

X

Get worker personal contacts event metadata

X

Get worker personal contact remove event metadata

X

HR: Work assignment management

Create work assignment for a worker

X

Get workers associate work assignment event metadata

X

HR: Worker

Get all workers

X

Get a worker

X

Get worker metadata

X

Hire worker

X

Rehire worker

X

Get a worker profile picture

X

Get worker photo remove event metadata

X

Event to remove worker photo meta and file

X

Upload worker photo

X

Get worker photo upload event metadata

X

HR: Worker associate profile: Personal and work info

Change worker's associate profile preferred gender pronoun

X

Get worker associate profile preferred gender pronoun change event metadata

X

HR: Worker demographics

Get all worker demographics

X

Get a worker demographic

X

Get worker demographic metadata

X

HR: Worker leaves

Get worker leave cancel event metadata

X

Cancel worker leave

X

Change worker leave

X

Get worker leave change event metadata

X

Get worker leave absence request event metadata

X

Request worker leave absence

X

Request worker leave return

X

Get worker leave return request event metadata

X

Get worker leaves details

X

HR: Worker profile experience (WFN)

Update worker's base remuneration

X

Read worker's base remuneration update metadata

X

Create worker's additional remunerations

X

Read worker's additional remunerations

X

Update worker's additional remunerations

X

Read reportable benefit metadata

X

Read additional remuneration metadata

X

Add worker's tax taxable benefits and allowances

X

Read worker's tax taxable benefits and allowances

X

Update worker's tax taxable benefits and allowances

X

Create a corporate group

X

Read additional corporate groups add/update metadata

X

Update worker dates

X

Change worker's primary assignment

X

HR: Workers: Biological data management

Change birth date

X

Change gender

X

Change race code

X

Change a workers gender self ID

X

Get worker gender identity change event metadata

X

HR: Workers: Business communication management

Add work cell

X

Change work cell

X

Remove work cell

X

Add work email

X

Change work email

X

Remove work email

X

Add work fax

X

Change work fax

X

Remove work fax

X

Add work pager

X

Change work pager

X

Remove work pager

X

Add work phone

X

Change work phone

X

Remove work phone

X

HR: Workers: Compensation management

Get worker work assignment additional remuneration add event metadata

X

Add a worker's additional remuneration

X

Get worker work assignment additional remuneration change event metadata

X

Change a worker's additional remuneration

X

Get worker work assignment base remuneration change event metadata

X

Change a worker's base remuneration

X

Remove a worker's additional remuneration

X

Get worker work assignment additional remuneration remove event metadata

X

HR: Workers: Custom data management

Change the worker custom field amount

X

Change the worker custom field code

X

Change the worker custom field date

X

Change the worker custom field indicator

X

Change the worker custom field number

X

Change the worker custom field percentage

X

Change the worker custom field string

X

Change the worker custom field telephone

X

Get worker custom field percentage change event metadata

X

Get worker custom field telephone change event metadata

X

Get worker custom field amount change event metadata

X

Get worker custom field code change event metadata

X

Get worker custom field date change event metadata

X

Get worker custom field indicator change event metadata

X

Get worker custom field number change event metadata

X

Get worker custom field string change event metadata

X

HR: Workers: Data integration management

Get worker read event metadata

X

Read worker data

X

HR: Workers: Demographic data management

Change marital status

X

Change maiden name

X

Change name

X

Get worker birth name change event metadata

X

Get worker legal name change event metadata

X

Get worker preferred name change event metadata

X

Change his/her preferred name in a given context

X

Get worker marital status change event metadata

X

Change a worker's military classification

X

Get worker military classification change event metadata

X

Get worker military status change event metadata

X

Change a worker military status

X

HR: Workers: Identification management

Add tax ID

X

Change tax ID

X

HR: Workers: KSAOC management

Change education level

X

Get worker highest level education change event metadata

X

HR: Workers: Lifecycle management

Rehire worker

X

Get rehire worker event metadata

X

HR: Workers: Person custom data management

Change the worker person custom field amount

X

Change the worker person custom field code

X

Change the worker person custom field date

X

Change the worker person custom field indicator

X

Change the worker person custom field number

X

Change the worker person custom field percentage

X

Change the worker person custom field string

X

Change the worker person custom field telephone

X

Get worker person custom field amount change event metadata

X

Get worker person custom field code change event metadata

X

Get worker person custom field date change event metadata

X

Get worker person custom field indicator change event metadata

X

Get worker person custom field number change event metadata

X

Get worker person custom field percentage change event metadata

X

Get worker person custom field string change event metadata

X

Get worker person custom field telephone change event metadata

X

HR: Workers: Personal communication management

Add home phone

X

Change home phone

X

Remove home phone

X

Add personal email

X

Change personal email

X

Remove personal email

X

Add legal address

X

Change legal address

X

Remove legal address

X

Add primary address

X

Change primary address

X

Remove primary address

X

Add personal fax

X

Change personal fax

X

Remove personal fax

X

Add personal mobile

X

Change personal mobile

X

Remove personal mobile

X

Add personal pager

X

Change personal pager

X

Remove personal pager

X

Get worker personal communication pager remove event metadata

X

HR: Workers: Work assignment management

Modify details of the assigned organizational units

X

Get worker work assignment assigned organizational units modify event metadata

X

Modify work assignment details

X

Get worker work assignment modify event metadata

X

Get worker reports to modify event metadata

X

Modify worker reports to details

X

Terminate worker work assignment

X

HR: Workers: Work deployment management

Change a worker's number of standard hours

X

Change a worker's worker type

X

Payroll: General ledger document management

Get a list of available general ledger documents

X

Get a single general ledger document

X

Payroll: Pay data input

Modify pay data input information

X

Get pay data input modify event metadata

X

Payroll: Pay statements

Get the details of a single client-specific pay statement as an image

X

Get the list of the last n client-specific pay statements for an associate

X

Payroll: Payroll group list of pay periods

Get the list of pay groups and their associated pay schedule/pay periods

X

Get a list of pay periods and pay schedule details for a given payroll group

X

Payroll: US tax profiles

Change a new US tax profile federal income tax instruction

X

Get US tax profile federal income tax instruction change event metadata

X

Get complete details of the worker US local tax profile

X

Get US tax profile local income tax instruction add event metadata

X

Add a new US tax profile local income tax instruction

X

Change a new US tax profile local income tax instruction

X

Get US tax profile local income tax instruction change event metadata

X

Remove an existing US tax profile local income tax instruction

X

Get US tax profile local income tax instruction remove event metadata

X

Get complete details of the worker US state tax profile

X

Get the list of all available US tax profiles that the requester is authorized to view

X

Add a new US tax profile state income tax instruction

X

Get US tax profile state income tax instruction add event metadata

X

Change a new US tax profile state income tax instruction

X

Get US tax profile state income tax instruction change event metadata

X

Payroll: Worker pay distributions and payroll instructions

Get pay distributions for a worker

X

Get a specific pay distributions for a worker

X

Get a worker payroll instructions

X

Change deductions

X

Start deductions

X

Stop deductions

X

Get worker pay distribution change event metadata

X

Change worker pay distribution

X

Get worker general deduction instruction change event metadata

X

Get worker general deduction instruction start event metadata

X

Get worker general deduction instruction stop event metadata

X

Get a worker general deduction instruction

X

Staffing: Job applicants

Change applicant's background assessment status

X

Modify job applicant's external screening packages

X

Change job applicant's external screening status

X

Initiate job applicant's external screening

X

Staffing: Job applications

Get a job application

X

Get the list of all available job applications that the requester is authorized to view

X

Staffing: Job requisition

Get a job requisition

X

Get the list of all available job requisitions

X

Staffing: Recruiting questionnaires (WFN and ADPRM)

Get details of the questionnaire identified by the questionnaire ID

X

Table

Get all business units

X

Get all cost numbers

X

Get all departments

X

Get all eligibility classes

X

Get all job titles

X

Get all locations

X

Get all pay grades

X

Get all union codes

X

Get all union locals

X

Get all degree achievement level

X

Get all major

X

Get all minor

X

Get all learning institution

X

Talent

Get all talents for a worker

X

Get a specific talent for a worker

X

Add awards

X

Remove awards

X

Add education

X

Change education

X

Remove education

X

Add languages

X

Change languages

X

Remove languages

X

Add licenses

X

Change licenses

X

Remove licenses

X

Add certifications

X

Change certifications

X

Remove certifications

X

Add memberships

X

Change memberships

X

Remove memberships

X

Add skills

X

Change skills

X

Remove skills

X

Talent: Associate certifications

Add certifications

X

Change certifications

X

Remove certifications

X

Get associate KSAOC certification add event metadata

X

Get associate KSAOC certification change event metadata

X

Get associate KSAOC certification remove event metadata

X

Get associate certifications event metadata

X

Get a specific certification for a given associate

X

Get the list of all available certifications for a given associate

X

Talent: Associate competencies

Add skills

X

Change skills

X

Remove skills

X

Get the list of all available competencies for a given associate

X

Get competencies for a given associate event metadata

X

Get a specific competency for a given associate

X

Get associate KSAOC competency add event metadata

X

Get associate KSAOC competency change event metadata

X

Get associate KSAOC competency remove event metadata

X

Talent: Associate educational degrees

Add education

X

Change education

X

Remove education

X

Get associate KSAOC educational degree add event metadata

X

Get associate KSAOC educational degree change event metadata

X

Get associate KSAOC educational degree remove event metadata

X

Get available educational degrees for a given associate event metadata

X

Get a specific educational degree for a given associate

X

Get the list of all available educational degrees for a given associate

X

Talent: Associate languages

Add languages

X

Change languages

X

Remove languages

X

Get associate KSAOC language add event metadata

X

Get associate KSAOC language change event metadata

X

Get associate KSAOC language remove event metadata

X

Get the list of all available languages for a given associate

X

Get a specific language for a given associate

X

Get languages for a given associate event metadata

X

Get a specific language for a given associate event metadata

X

Talent: Associate licenses

Add licenses

X

Change licenses

X

Remove licenses

X

Get associate KSAOC license add event metadata

X

Get associate KSAOC license change event metadata

X

Get associate KSAOC license remove event metadata

X

Get a specific license for a given associate event metadata

X

Get the list of all available licenses for a given associate

X

Get a specific license for a given associate

X

Get available licenses for a given associate event metadata

X

Talent: Associate memberships

Add memberships

X

Change memberships

X

Remove memberships

X

Add associate KSAOC membership event notifications

X

Get associate KSAOC membership add event metadata

X

Change associate KSAOC membership event notifications

X

Get associate KSAOC membership change event metadata

X

Get associate KSAOC membership remove event metadata

X

Remove associate KSAOC membership event notifications

X

Get a specific membership for a given associate

X

Get a specific membership for a given associate event metadata

X

Get the list of all available memberships for a given associate

X

Get available memberships for a given associate event metadata

X

An associate's membership add review request

X

Get associate KSAOC membership add review event metadata

X

Communicates the occurrence of a membership add review event

X

Communicates the occurrence of a membership change review event

X

An associate's membership change review request

X

Get associate KSAOC membership change review event metadata

X

Get associate KSAOC membership remove review event metadata

X

An associate's membership remove review request

X

Communicates the occurrence of a membership remove review event

X

Talent: Associate recognitions

Add awards

X

Remove awards

X

Get associate KSAOC recognition add event metadata

X

Get associate KSAOC recognition change event metadata

X

Change an associate's recognition

X

Get associate KSAOC recognition remove event metadata

X

Get available recognitions for a given associate event metadata

X

Get the list of all available recognitions for a given associate

X

Time

Time off

X

Time: Data collection entries

Process data collection entries event instance

X

Get an event instance identified by the event ID

X

Time: Labor charge codes upload management

Get metadata information for labor allocation field configuration

X

Get status for labor charge fields upload

X

Upload the labor charge fields both flat and hierarchical values

X

Time: Team time cards

Get a worker's team's timecards

X

Time: Time card inputs

Submit worker time card input data for processing

X

Time: Time cards

Modify time entries event instance

X

Time: Time off balances

Modify time off balances meta

X

Modify time off balances

X

Time: Time off management

Cancelling of an existing paid time off request

X

Get the list of time off balances and entries as of today as per the system of record's time by default

X

Get the list of paid time off configuration with the O/A representing the target associate

X

Get the list of time off requests for the associate as identified by the O/A in the URI

X

Create a request for paid time off

X

Time: Time off requests

Get summaries of all available worker time off requests that the requester is authorized to view

X

Get summaries of all available time off requests for the team that the requester is authorized to view

X

Time: Work schedule import management

Upload the work schedule entries

X

Get the status of uploaded work schedule entry import

X

Time: Work schedules

Get work schedule day add event event metadata

X

Add a new day to an employee schedule

X

Add a new employee schedule

X

Get work schedule add event metadata

X

Change a day within an existing employee schedule

X

Get work schedule day change event metadata

X

Change a entry within an existing employee schedule

X

Change an existing employee schedule

X

Get work schedule change event metadata

X

Copy all entries from one day to another within an existing employee schedule

X

Get work schedule day copy event metadata

X

Copy an existing employee schedule to another employee

X

Get work schedule copy event metadata

X

Remove a day from the existing employee schedule

X

Get work schedule day remove event metadata

X

Get work schedule remove event metadata

X

Remove an existing employee schedule

X

Get the list of all available team work schedules that the requester is authorized to view

X

Get the list of all available work schedules that the requester is authorized to view

X