The employee's additional jobs and international assignments.

The position's job type which can be one of the following values: Primary, Additional Job, or International Assignment. If the position is not effective, no value will be returned. Primary and additional job are effective dated due to the Switch Primary Job business process. An international assignment cannot be switched to a be a primary job.

The location associated with the filled position or position restrictions. When associated with position restrictions, the location returned is in this order: the location on the effective job requisition, hiring restrictions, or primary location of the supervisory organization.

The supervisory organization for the position.

The work space associated with the position.

Returns the public primary work email address for the worker.

Returns the primary public work phone number for the worker.

Returns the country from the primary address for the location.

Location chain including bread crumbs for location.

The Employee ID or Contingent Worker ID for the worker.

Retrieves the employee type or contingent worker type for the worker.

Workers

Leave of Absence Type

Absence Table

Time Off

Absence Types

Business Process Event Steps

Business Process Events

Business Process Types

Inbox Tasks

Leave Statuses

Leaves of Absence

Organizations

PaySlips

TimeoffDetails

TimeOffPlans

TimeOff Statuses

Workday

Approves the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.

Approve TimeOff Request

Denies the business process event step specified by the ID of the originating event step. The processing person must have view access to the event. In the request body, specify these required fields: id (the event step you are denying), stepAction{id} (if there are multiple event steps), comment.

Cancel TimeOff Request

Creates a time off request for the specified worker ID and initiates the Request Time Off business process.
In the request body, if using business process parameters, specify at least the required field: action {id}. You must specify the submit action WID: d9e4223e446c11de98360015c5e6daf6 Secured by: Request Time Off (REST Service)
Scope: Time Off and Leave

Creates a time off request for the specified worker ID and initiates the business process.

Retrieves the work experience with the specified ID for the specified \~prospect\~.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves a single experience instance for a \~prospect\~.

Retrieves a collection of interviews.

Secured by: Interview Feedback Public API

Scope: Recruiting

Retrieves instances that can be used as values for other endpoint parameters in this service.

Retrieves all job postings. You can filter by categories and job sites.

Secured by: Job Postings: External

Scope: Recruiting

Retrieves a collection of job postings.

Creates a single \~prospect\~ instance with the specified data. In the request body, specify at least the required field: candidate.name.country.id. The Recruiting Name Components configuration might require additional fields for candidate.name. To determine additional required fields, see the Recruiting Name Components tab on the Maintain Name Components by \~Country\~ task.

Secured by: Create External Prospects, Set Up: External Career Site Access

Scope: Recruiting

Create \~prospects\~.

Retrieves the language with the specified ID for the specified \~prospect\~.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves a single language instance for a \~prospect\~.

Retrieves the education of the \~prospect\~ with the specified ID.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves the education of a single \~prospect\~ instance.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100.  In the request body, specify at least these required fields: schoolName.

Secured by: Create External Prospects

Scope: Recruiting

Creates educations for a \~prospect\~.

Retrieves interview feedback for the specified ID.

Secured by: Interview Feedback Public API

Scope: Recruiting

Retrieves the skill with the specified ID for the specified \~prospect\~.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves a single skill instance for a \~prospect\~.

Retrieves the resume attachment with the specified ID for the specified \~prospect\~.

Secured by: Candidate Data: Attachments

Scope: Recruiting

Retrieves a single resume attachment instance for a \~prospect\~.

Retrieves a job posting with the specified ID

Secured by: Job Postings: External

Scope: Recruiting

Retrieves a job posting.

Retrieves the work experience of the \~prospect\~ with the specified ID.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves the work experience of a single \~prospect\~ instance.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100.  In the request body, specify at least these required fields: companyName, title, startYear.

Secured by: Create External Prospects

Scope: Recruiting

Creates experiences for a \~prospect\~.

Submits interview details for the processing \~worker\~ with the interviewer's rating and comment.

Secured by: Interview Feedback Public API

Scope: Recruiting

Retrieves attached resumes for the \~prospect\~ with the specified ID.

Secured by: Candidate Data: Attachments

Scope: Recruiting

Retrieves attached resumes for a single \~prospect\~ instance.

Creates a single resume attachment instance with the specified data. In the request body, specify at least these required fields: fileName, attachmentContent.

Secured by: Create External Prospects, Set Up: External Career Site Access

Scope: Recruiting

Contains attachment(s)

Creates resume attachments for a \~prospect\~.

Retrieves the education with specified ID for the specified \~prospect\~.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves a single education instance for a \~prospect\~.

Retrieves the languages of the \~prospect\~ with the specified ID.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves the languages of a single \~prospect\~ instance.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: language.id, abilities, abilities.abilityType.

Secured by: Create External Prospects

Scope: Recruiting

Creates languages for a \~prospect\~.

Retrieves the skills of the \~prospect\~ with the specified ID.

Secured by: Prospects

Scope: Recruiting, Talent Pipeline

Retrieves the skills of a single \~prospect\~ instance.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: name.

Secured by: Create External Prospects

Scope: Recruiting

Creates skills for a \~prospect\~.

Retrieves the \~prospect\~ with the specified ID.

Secured by: Prospects, Set Up: External Career Site Access

Scope: Recruiting, Talent Pipeline

Retrieves a single \~prospect\~ instance.

Retrieves a data source for the specified {ID} for use in a WQL query. You can only view data sources that you have security access to.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Retrieves a data source for the specified {ID} for use in a WQL query.

Retrieves the data source filter with the specified {ID} for a specific data source. You can only view data sources and data source filters that you have security access to.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Retrieves the data source filter with the specified {ID} for a specific data source.

Retrieves a data source filter of the data source.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Retrieves a data source filter of the data source.

Returns the data from a WQL query. You can only view data you have security access to.

Secured by: Development, Set Up: Plan Publishing, WQL for Workday Extend, Workday Query Language+TG

Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, System

Returns the data from a WQL query.

Returns the data from a WQL query. The read-only POST request accommodates queries greater than 2,048 characters. You can only view data you have security access to.

Secured by: Development, Set Up: Plan Publishing, WQL for Workday Extend, Workday Query Language+TG

Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, System

Returns the data from a WQL query. The read-only POST request accommodates queries greater than 2,048 characters.

Retrieves a collection of data sources for use in a WQL query. You can only view data sources that you have security access to.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Retrieves a collection of data sources for use in a WQL query.

Retrieves the field with a specified {ID} for the specific data source. You can only view fields and data sources that you have security access to.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Retrieves the field with a specified {ID} for the specific data source.

Retrieves a field of the data source instance.

Secured by: Development, WQL for Workday Extend, Workday Query Language+TG

Scope: System

Retrieves a field of the data source instance.

Validates the allowed and required worktag types and worktag combinations based on the configuration in the 'Maintain Related Worktag Usage' and 'Maintain Worktag Usage' tasks and related worktags. This endpoint enables you to correct errors before you submit transactions that include worktags.

This POST endpoint is a read-only POST that submits the request for validation. This endpoint doesn't add data to Workday.

In the request body, specify the required field: taggableConfiguration{ id }, where id uses the format Taggable_Type_ID={referenceID}. You can get the Reference ID of the taggable type from the View Taggable Types task. Example id: Taggable_Type_ID=EXPENSE_REPORT

You can optionally specify these fields in the request body:

* worktags [{id}] where id is the reference ID of the worktag. Example: Organization_Reference_ID=REGION-4-132

* validationTypes[{id}] where id uses the format Worktags_REST_Validation_Type_ID={referenceID}. You can get the Reference ID of the validation type from the Worktags REST Validation Types report. Example: Worktags_REST_Validation_Type_ID=INACTIVE_WORKTAG_TYPES

* restrictions[{id}] where id is the reference ID of the worktag type configured with 'Restricted To' values. Example: Company_Reference_ID=COMPANY-10-209

For details and examples, see Community > REST API Guides > Validate Worktags REST API.

Secured by: Manage: Related Worktags, Worktag REST API

Scope: Common Financial Management, Worktags

Validates worktags.

Retrieves a worker time block with the specified ID.

Secured by: Process: Time Block REST APIs

Scope: Time Tracking

Retrieves a worker time block.

Retrieves a collection of time clock events. You can filter by the time clock events by worker and date range.

Secured by: Process: Time Clock Event REST API's

Scope: Time Tracking

Retrieves a collection of time clock events for a worker for a date range.

Adds a time clock event for the specified worker.

In the request body, these fields are required:

* worker

* eventType

* dateTime

* timeZone

* Position can be required if worker has multiple positions.

* One of timeEntryCode, project, or projectPlanTask. These fields are mutually exclusive. Specify 1 of these fields in the request body.

For the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date.

For a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.

For a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.

Secured by: Process: Time Clock Event REST API's

Scope: Time Tracking

Creates time clock events for specified workers.

Creates a Time Review Event or Time Review Events for the specified worker.
Specify these required fields in the request body:
*date: the date that constructs the Time Review Event. The date is used to create Time Review Events for the Period or Week, depending on how that worker's Time Entry Template is configured.

Additional optional field:
*comment: Comment related to the BP that persists on each Time Review Event. Comments aren't allowed if disabled on the Enter Time BP

To get more information about Custom Administrator configured Critical Time Validations, use the GET timeValidations API.

This POST method is equivalent to Submit Time in Workday.

Secured by: Manager: Time Tracking Manager Approval, Manager: Time Tracking Manager Edit and Approve, Submit Time (REST Service)

Scope: Time Tracking, Time Tracking Hub

Creates a Time Review Event or Time Review Events.

Retrieves a summary of reported hours for a worker over a period. The period contains the specified date or, if not specified, it contains today's date.

Secured by: Process: Time Block REST APIs, Process: Time Clock Event REST API's

Scope: Time Tracking

Retrieves a summary of reported hours for a worker over a period.

Retrieves a collection of time entry validations for the specified worker on the specified date. This method requires the date and worker query parameters.

The validation messages returned by this method indicate that the time entries failed the critical or warning custom validations configured in the Maintain Time Entry Validations task.

Secured by: Process: Time Block REST APIs

Scope: Time Tracking

Retrieves a collection of time entry validations.

Retrieves a time clock event with the specified ID.

Secured by: Process: Time Clock Event REST API's

Scope: Time Tracking

Retrieves a time clock event.

Updates the time clock event for the specified ID. Replaces the existing time clock event with the specified data in the request body.

The timeEntryCode, project, and projectPlanTask fields are mutually exclusive. You can only specify 1 of these fields in the request body.

For the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date.

For a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.

For a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.

Secured by: Process: Time Clock Event REST API's

Scope: Time Tracking

Updates the time clock event for the specified ID.

Deletes a time clock event with the specified ID.

Secured by: Process: Delete Time Clock Event REST API's

Scope: Time Tracking

Deletes a time clock event.

Returns the period from the period schedule the worker is eligible for, on the given date. If you don't specify a date, today's date is used. This endpoint returns only 1 period.

Secured by: Process: Time Tracking Configuration Objects REST APIs

Scope: Time Tracking

Retrieves a period from the period schedule the worker is eligible for.

Retrieves a collection of workers and current staffing information.

Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports

Scope: Staffing

Retrieves a collection of workers and current staffing information.

Creates a worker time block for the specified worker. Specify these required fields in the request body:

* calendarDate and reportedQuantity - If the worker is hourly.

* inTime, outTime, inTimeZone and outTimeZone - If the worker is in and out.

* One of timeEntryCode, project, or projectPlanTask. These fields are mutually exclusive. Specify 1 of these fields in the request body.

For the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date.

For a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.

For a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.

Secured by: Process: Time Block REST APIs

Scope: Time Tracking

Creates a worker time block.

Deletes a worker time block with the specified ID for the specified worker.

Secured by: Process: Time Block REST APIs

Scope: Time Tracking

Deletes a specified worker time block.

Updates the worker time block for the specified worker with the specified data in the request body.

The timeEntryCode, project, and projectPlanTask fields are mutually exclusive. You can only specify 1 of these fields in the request body.

For the timeEntryCode id, you can use a returned id from GET /values/timeTypes/timeEntryCodes, which returns the time entry codes that the given worker is eligible for on the given date.

For a valid project id, you can use a returned id from GET /values/timeTypes/projects, which you can filter by date and worker.

For a valid projectPlanTask id, you can use a returned id from GET /values/timeTypes/projectPlanTasks, which you can filter by date, worker, and project.

Secured by: Process: Time Block REST APIs

Scope: Time Tracking

Updates a specified worker time block.

Retrieves time blocks for specified workers over a date range. This method does not return incomplete time blocks, time offs, and overtime request blocks.

Secured by: Process: Time Block REST APIs

Scope: Time Tracking

Retrieves time blocks for specified workers over a date range.

Functional Description
---
The Close Mentorship endpoint will be used to Close mentorships.

Example Use Cases
---
ESS: Worker or Mentor wants to close the mentorship.

Additional Information
---
* Security for ESS and MSS follows the security policy of the Manage Mentorship business process policy.
** Close \~Mentorship\~ with
* If the business policy for Manage \~Mentorship\~ has an approval step, then the mentorship will not be closed until the mentorship event is approved.

Secured by: Close \~Mentorship\~ with

Scope: Career and Development Planning, Worker Profile and Skills

Closes the mentorship.

Functional Description
---
The Edit Mentorship endpoint will be used to Edit the mentorships.

Example Use Cases
---
ESS: Worker or Mentor wants to edit the mentorship to update additional informations.

Additional Information
---
* Security for ESS and MSS follows the security policy of the Manage Mentorship business process policy.
Edit \~Mentorship\~ with
* If the business policy for Manage \~Mentorship\~ has an approval step, then the mentorship will not be updated until the mentorship event is approved.

Secured by: Edit \~Mentorship\~ with

Scope: Career and Development Planning, Worker Profile and Skills

Edit the mentorship.

Returns mentorships viewable by authenticated user.

Secured by: Self-Service: Mentoring, Worker Data: Mentoring

Scope: Career and Development Planning, Worker Profile and Skills

Get all mentorships

Functional Description
---
The Create Mentorship For Worker endpoint is used to create new mentorships for between two workers.

Example Use Cases
---
A manager can create a mentorship for their direct report, and have the ability to choose a mentor, mentor type, and provide a purpose.
An Admin can create a mentorship between a worker and a mentor.

Additional Information
---
The security follows the security policy of the Manage Mentorship business process.
The mentee, mentor, mentor type, purpose, and comment are specified in the body of the request.
If the business definition for Manage \~Mentorship\~ has an approval step, then the mentorship is not created until the mentorship event is approved in Workday.

Secured by: Add a \~Mentor\~ for \~Worker\~

Scope: Career and Development Planning, Worker Profile and Skills

Creates a mentorship between two workers.

Functional Description
---
The Create Mentorship For Me endpoint is used by a user to create new mentorships for themself.

Example Use Cases
---
ESS: An employee wants to create a mentorship for themselves and choose a mentor, mentor type, and provide a purpose.

Additional Information
---
* The security for the employee follows the security policy of the Manage Mentorship business process.
* The mentee will default to current processing worker, and the mentor is specified in the body of the request.
* If the business definition for Manage Mentorship has an approval step, then the mentorship is not created until the mentorship event is approved in Workday.

Secured by: Add a \~Mentor\~

Scope: Career and Development Planning, Worker Profile and Skills

Creates a mentorship for the current processing worker where the user is also the mentee.

Secured by: System Monitor Administrator, System Monitor Support

Scope: System, System Health Dashboard, Tenant Non-Configurable

Retrieves all active user sessions.

Secured by: System Monitor Administrator, System Monitor Support

Scope: System, System Health Dashboard, Tenant Non-Configurable

Retrieves a collection of active user sessions.

Retrieves the active user session with the specified ID.

Secured by: System Monitor Administrator, System Monitor Support

Scope: System, System Health Dashboard, Tenant Non-Configurable

Retrieves an active user session.

Retrieves a collection of system metrics, including queued tasks, running tasks, and active user sessions.

Secured by: System Monitor Administrator, System Monitor Support

Scope: System, System Health Dashboard, Tenant Non-Configurable

Retrieves system metrics with the specified ID, including queued tasks, running tasks, and active user sessions.

Retrieves system metrics with the specified ID, including queued tasks, running tasks, and active user sessions.

Secured by: System Monitor Administrator, System Monitor Support

Scope: System, System Health Dashboard, Tenant Non-Configurable

Retrieves system metrics.

Retrieves all students. You can filter by academicLevel, academicUnit, programOfStudy etc.

Secured by: External Student Site System Access, Reports: Students, Self-Service: Student Profile, Set Up: Student Sites

Scope: Academic Foundation, Student Core

Retrieves a collection of students.

Retrieves a student with the specified ID.

Secured by: External Student Site System Access, Reports: Students, Self-Service: Student Profile, Set Up: Student Sites

Scope: Academic Foundation, Student Core

Retrieves a student instance.

Retrieves a student payment for the specified student ID.

Secured by: Manage: Student Payment Processing

Scope: Student Financials

Retrieves a single student payment instance for the specified student ID.

Partially updates an existing student payment instance for the specified student ID with the specified data in the request body.  In the request body, specify at least this required field: reason{id}

Secured by: Manage: Student Payment Adjustment Processing

Scope: Student Financials

Partially updates an existing student payment for the student instance.

Retrieves a collection of payment information. You can filter the payments by institutional academic unit, payment type, payment reference, or payment transaction date.

Secured by: Manage: Student Payment Processing

Scope: Student Financials

Retrieves a collection of student payments.

Creates a single student payment instance with the specified data.  In the request body, specify at least these required fields: academicPeriod{id}, institutionalAcademicUnit{id}, paymentType{id}, amount.   You can call GET /students/{ID}/payments or GET /students/{ID}/payments/{subresourceID} to get existing payment information that helps you specify the required data in the request body.

Secured by: Manage: Student Payment Processing

Scope: Student Financials

Creates a student payment.

Retrieves a collection of student holds assigned to the specified student ID. This method also returns the student hold reasons and the processes that the holds apply to. You can filter student holds by their hold reason (exact match), hold type (any in common), and whether or not the hold is inactive.

Secured by: Manage: Holds, Self-Service: Holds

Scope: Action Items and Holds

Retrieves a collection of student holds assigned to the specified student ID.

Retrieves a student hold assigned to the specified student ID.

Secured by: Manage: Holds, Self-Service: Holds

Scope: Action Items and Holds

Retrieves a single student hold instance for the specified student.

Retrieves a collection of courses.

Secured by: Manage: Curriculum Management

Scope: Student Records

Retrieves a collection of course sections.

Secured by: Manage: Curriculum Management

Scope: Student Records

Retrieves a collection of course subjects.

Secured by: Manage: Curriculum Management

Scope: Student Records

Retrieves an immigration event with the specified ID.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Retrieves an immigration event.

Retrieves a collection of residence information for the specified student ID. You can filter residence information by their institutionalAcademicUnit.

Secured by: Manage: Student Residency, Self-Service: Student External Site User Access

Scope: Academic Foundation, Student Core

Retrieves a collection of residence information for the specified student ID.

Retrieves a dependent immigration data for the specified student ID.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Retrieves a dependent immigration data instance for the specified student ID.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Delete immigration event dependent immigration data.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Delete immigration event dependent immigration data.

Submits an immigration event, which advances the Student Applicant Immigration Event business process to the next step. Specify an empty request body: {}

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Submits an immigration event.

Retrieves immigration data with the specified ID for the specified immigration event.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Retrieves an immigration data instance for the specified immigration event.

Retrieves a collection of dependent immigration data for the specified student ID.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Retrieves a collection of dependent immigration data for the specified student ID.

Creates dependent immigration data for the immigration event with the specified data.

Secured by: Self-Service: Student External Site User Access, Student Data: Immigration

Scope: Academic Foundation, Student Core

Creates dependent immigration data for the specified immigration event.

Quickbooks

Gusto

Rippling HR

BambooHR

Sage HR

ADP Workforce Now

Workable

Personio

Deel

Google Workspace

HiBob

Lightspeed R-Series

Isolved

Everee

# Continuous Import of Employees to Your App

This scenario enables your application to continuously sync Employees from any external application to your app's API. It handles the initial import of Employees and keeps them synchronized when a Employee is created, updated, or deleted in the external application.

When receiving Employees data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Employees to my App

Import Employees and receive created/updated or deleted events

# Realtime Full two-way Sync of Employees

This scenario enables your application to fully sync Employees between your app and any external application in both directions. It handles the initial import/export of Employees and then sends events when a Employee is created, updated, or deleted on any side, as close to real-time as possible.

Employee fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Employees in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Employees to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Employees

Bi-directional realtime sync of Employees with records deduplication

# Get all Employees

This scenario enables your application to get a complete list of Employees from any external application to your app's API in the same way. 

When receiving Employees data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Employees along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Employees page by page.


Get all Employees

Imports all Employees from any external application to your App.

Field Name	API Key	Type	Description
Id	id	string	Id of the instance
Descriptor	descriptor	string	A preview of the instance
Href	href	string
Primary Supervisory Organization	primarySupervisoryOrganization	object
Descriptor	primarySupervisoryOrganization.descriptor	string

Workday API Integration Profile

How to work with Workers in Workday API

Operations on Workers Collection

Build every single integration your customers need with AI