Skip to main content
Workday logo
  • Category: human resources
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 588
  • Triggers: 13
  • Slug: WORKDAY
  • Version: 20261101_00

Tools

Slug: WORKDAY_APPROVE_BUSINESS_PROCESS_EVENT_STEPApproves the specified business process event step (Approval step type). Use this to move an Approval-typed step from awaiting state to approved and continue the workflow. The caller must be in the awaiting-person list for the step.

Input Parameters

string
required
The Workday ID of the business process event step to approve.
string
required
Approval comment recorded on the event step. Workday requires a comment for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_BULK_IMPORT_UPDATE_EMPLOYEE_REVIEW_RATINGBulk-import employee review rating updates into Workday Performance Management as an asynchronous EIB import. Each item in update_employee_review_rating_requests must contain an Update_Employee_Review_Rating_Data element and may contain an Update_Employee_Review_Rating_Reference. Do not include an outer Update_Employee_Review_Rating_Request key: Composio adds it automatically, and double-wrapping makes the asynchronous Workday job fail despite an HTTP 200. HTTP 200 only means Workday accepted the import for asynchronous processing; verify final success via the returned Import_Process_Reference with the Get Import Processes / Get Import Process Messages tools.

Input Parameters

array
required
List of review-rating update requests. Each item must contain the child fields of a Workday Update_Employee_Review_Rating_Request element directly; do not include an outer Update_Employee_Review_Rating_Request key because Composio adds that wrapper. Each item must include Update_Employee_Review_Rating_Data, whose child fields include ID, Rating_Reference, Override_Overall_Rating, Manual_Override, Comment, and Review_Section_Evaluation_Data. An optional Update_Employee_Review_Rating_Reference may appear alongside the data element. Use Workday SOAP element names as keys, nested dicts/lists for child elements, @name keys for XML attributes, and #text for element text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CANCEL_BUSINESS_PROCESS_EVENTCancels an in-progress business process event. Use this to terminate a business process before it completes. The optional comment is preserved on the event record. The caller must have permission to cancel the event under Workday’s security model for the business process type.

Input Parameters

string
required
The Workday ID of the business process event to cancel.
string
Optional reason recorded on the event for the cancellation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CHANGE_BENEFITSReplace an employee’s complete Workday benefit election set for one life event. This operation is not incremental: include every benefit plan available for the event type because omitted elections may be removed or waived. Empty election submissions are rejected because Workday defines no universal waive-all request.

Input Parameters

string
Optional business-process comment.
boolean
Process the business process before returning the response.
string
required
Date of the qualifying life event.
boolean
Automatically approve and bypass all business-process steps and notifications.
array
Complete direct Benefit_Election_Data set for the event type. Include every applicable plan because Workday does not preserve omissions or apply defaults.
object
required
Employee whose complete benefit election set will be replaced.
array
Required employee tobacco-use responses.
string
Excess benefit package credits directed to an HSA.
string
Original signature date for migrated enrollment data.
object
Worker who signed the enrollment event.
array
Required spouse or domestic partner tobacco-use responses.
string
Date the enrollment event was signed.
object
required
The single qualifying event type controlling available benefit plans.
boolean
required
Required acknowledgement that all applicable direct and grouped retirement elections for the event type are included.
boolean
Whether a medical waiver is backed by outside coverage.
array
Other health care insurance records for the worker.
array
Other health care insurance records grouped by dependent.
boolean
Do not create an event when a critical exit validation fails.
array
Complete grouped retirement elections and coverage-level contributions.
integer
Remaining payroll deduction periods.
object
Benefit deduction frequency for remaining periods.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CHANGE_WORKER_MARITAL_STATUSChange one worker’s marital status with the Workday Human_Resources v46.2 Change_Personal_Information SOAP operation. This initiates the tenant’s single Personal Information Change business process with configured approvals intact. The request exits on initiation-step validation errors instead of leaving an invalid event in progress. Requires the Staffing scope, access to the Person Data: Personal Information or Self-Service: Personal Information security domain, and permission to initiate the Personal Information Change business process. For integration-system-user initiation, Workday may not run every validation that interactive user initiation runs; validate tenant business rules before submitting.

Input Parameters

string
required
Workday worker identifier whose marital status will change.
string
Optional country context for the personal-information change. If omitted, Workday uses the person’s primary-position location.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Official Workday RoleObject identifier type used for person_id.
string ("WID" | "ISO_3166-1_Alpha-2_Code" | "ISO_3166-1_Alpha-3_Code" | "ISO_3166-1_Numeric-3_Code" | "OPM_Country_Code")
Official Workday CountryObject identifier type used when country_id is set.
string
required
Active tenant marital-status identifier to assign to the person.
string
Optional date on which the new marital status took effect.
string ("WID" | "Marital_Status_Code" | "Marital_Status_ID")
Official Workday Marital_StatusObject identifier type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CHANGE_WORKER_MILITARY_SERVICEAdd or update one worker military service entry with Workday Human_Resources v46.2 Change_Personal_Information while preserving all other entries. Requires the Personal Data scope, access to the Person Data: Personal Information or Self-Service: Personal Information security domain, military-status localization configuration, and permission to initiate the Personal Information Change business process. The process keeps configured approvals, reviews, notifications, and to-dos, and exits on initiation-step validation errors; an initiated response does not mean those steps completed. Deletion is not supported.

Input Parameters

string
Optional military service notes accepted by Workday’s RichText field.
string
required
Workday worker identifier whose military service entry will change.
string
Optional country context for military-information localization. If omitted, Workday derives location context from the person’s primary position.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Official Workday RoleObject identifier type used for person_id.
string ("WID" | "ISO_3166-1_Alpha-2_Code" | "ISO_3166-1_Alpha-3_Code" | "ISO_3166-1_Numeric-3_Code" | "OPM_Country_Code")
Official Workday CountryObject identifier type used when country_id is set.
string
Optional military rank valid for the service type and status country.
string
required
Active tenant military-status identifier valid for the worker’s country context.
string
Existing military service entry identifier to update. Omit only when adding one new entry; this action never deletes entries.
string ("WID" | "Military_Rank_ID")
Official Workday Military_RankObject identifier type.
string
Optional date on which the person was discharged from military service.
string ("WID" | "Armed_Forces_Status_ID" | "Military_Status_ID")
Official Workday Military_StatusObject identifier type.
string ("WID" | "Military_Service_ID")
Official Workday Military_Service_ReferenceObject identifier type used when military_service_id is set.
string
Optional active military service type valid for the status country.
string
Optional active military discharge type valid for the status country.
string
Optional date on which the military status began.
string ("WID" | "Military_Service_Type_ID")
Official Workday Military_Service_TypeObject identifier type.
string ("WID" | "Military_Discharge_Type_ID")
Official Workday Military_Discharge_TypeObject identifier type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CLOSE_REQUESTCloses a specified request with a given resolution. Security is evaluated based on the request event awaiting the processing person’s action. If workdayObjectValue is provided, ensure the user has View permission on the referenced Workday Object.

Input Parameters

string
required
The Workday ID of the request to close.
string
Latest comment for the request event.
string
Request ID (per the ID generator format).
object
required
The Workday ID of the resolution to apply. Required field. Valid values: 00000000000000000000000000000104 (Done), 00000000000000000000000000000108 (Duplicate), 00000000000000000000000000000109 (Denied), 00000000000000000000000000000107 (Canceled).
object
A reference to a Workday instance (id only required).
object
A reference to a Workday instance (id only required).
object
A reference to a Workday instance (id only required).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_BUSINESS_TITLE_CHANGECreates a business title change instance for a worker via the Workday Common API v1. Use when you need to initiate a business title change request for an employee, setting the proposed new business title.

Input Parameters

string
required
The Workday ID of the worker resource for whom to create the business title change.
string
required
The new business title for the worker as of the effective date. If there is no business title override, the default is the job title or job profile name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CASECreate one Workday Help case. The selected case type must be available to the case owner; use List Case Types with the same worker ID before creating on behalf of another worker.

Input Parameters

string
required
Case title, up to 140 characters.
object
Valid Help case source.
object
required
Case type available to the case owner.
object
Worker who will own the case.
object
Different worker whom the case concerns.
array
Previously uploaded Help attachment references.
string
Detailed case description.
object
External creator who will own the case.
object
Case questionnaire response holder associated with the selected case type.
object
Typed answers for the selected case type’s questionnaire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_COMPENSATION_SCORECARDCreates a new Compensation Scorecard on Workday’s Compensation v3 API. Use this to introduce a new merit-and-bonus evaluation template — for example, when modeling FY-level goals or rolling out a refreshed scoring structure to managers. Secured by: Set Up: Merit and Bonus. Required body fields: scorecardName, effectiveDate, and a non-empty defaultScorecardGoals[] (each entry needs goalName and goalWeight). scorecardProfiles[] is optional but each profile must specify eligibilityRule.id and at least one profileScorecardGoals[] entry when supplied.

Input Parameters

string
Optional Workday ID or Reference ID for the new scorecard; usually omitted so Workday generates one.
boolean
True marks the new scorecard as inactive. Defaults to false in Workday when omitted.
string
required
The Effective Date of the Compensation Scorecard in YYYY-MM-DD format.
string
required
The name of the Compensation Scorecard.
array
Optional profile-specific sections. Each profile requires an eligibilityRule.id and at least one entry in profileScorecardGoals.
string
Free-text description of the Compensation Scorecard.
array
required
The default goals for the Compensation Scorecard. Each goal must specify goalName and goalWeight.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CUSTOM_FIELD_TYPECreates a new custom field type in Workday’s custom object configuration store. Use this when you need to register a new field type (e.g. a list of custom values, a numeric field with bespoke validation) that custom object definitions can subsequently reference via their fields collection.

Input Parameters

object
required
JSON body describing the custom field type to create. The Workday spec defines this schema as an opaque hash with no documented properties; supply the fields per Workday Designer documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CUSTOM_FIELD_TYPE_LIST_VALUEAdds a single list value to a custom list field type used by custom object definitions. Use this when you need to extend the set of selectable values exposed by a custom list field (for example, a “Region” field whose options grow over time).

Input Parameters

string
required
The Workday ID of the custom field type (custom list) that the new list value belongs to.
object
required
JSON body describing the list value to create. The Workday spec defines this schema as an opaque hash with no documented properties; supply fields per Workday Designer documentation (typically name and optionally description).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CUSTOM_OBJECTCreates (or updates) custom object instance(s) attached to a Workday business object. The same endpoint serves both single-instance custom objects (at most one instance per business object, e.g. a worker’s Parking Space) and multi-instance custom objects (many instances per business object, e.g. a worker’s Stock Grants). The custom object’s definition determines the mode; bulk=true accepts an array body and is typically used with multi-instance definitions.

Input Parameters

boolean
If true, accepts an array of custom object instances in the request body. Defaults to false.
boolean
If true, updates the custom object instance if it exists. Defaults to false.
string
required
The custom object data to persist. If bulk=true, provide a JSON array of instances (max 100). If bulk=false (default), provide a single JSON object. Include the extended Workday object reference (e.g. {‘worker’: {‘id’: ‘<wid>’}}) and the custom fields.
string
required
The web service alias of the custom object. Determine this by running the ‘View Custom Object’ task in Workday. The alias resolves to either a single-instance or multi-instance custom object definition; the endpoint is the same in either case.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CUSTOM_OBJECT_DEFINITION_CONDITION_RULEAdds a condition rule to an existing custom object definition. Use this when you need to attach a visibility, edit-restriction, or business-logic rule to the custom object before it is activated.

Input Parameters

string
required
The Workday ID of the custom object definition that the condition rule belongs to.
object
required
JSON body describing the condition rule to create. Provide fields per Workday Designer documentation; the spec does not enumerate documented properties for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CUSTOM_OBJECT_DEFINITION_FIELDAdds a field to an existing custom object definition. Use this once a custom object definition is created and you need to populate its schema with individual data fields (text, numeric, list-of-values, etc.) prior to activation.

Input Parameters

string
required
The Workday ID of the custom object definition that the new field belongs to.
object
required
JSON body describing the field to create. Workday accepts name, alias, fieldType (instance reference whose id is a real Workday Field Type WID), and the optional list-of-references fields categories and authorizedUsages. Do NOT send required — Workday returns unrecognized field: required for it on this endpoint. The spec does not enumerate documented properties for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_CUSTOM_OBJECT_DEFINITION_VALIDATIONAdds a validation to an existing custom object definition. Use this to attach data-quality / business-rule validations to a custom object before it is activated (for example, “Effective Date must be in the future” or “Amount must be greater than zero”).

Input Parameters

string
required
The Workday ID of the custom object definition that the validation belongs to.
object
required
JSON body describing the validation to create. Provide fields per Workday Designer documentation (typically name, the validation expression, and the error message). The spec does not enumerate documented properties for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_EXPENSE_ENTRYCreates a Quick Expense entry in Workday Expense v1. The date (Transaction Date) and expenseItem fields are required; merchant, memo, amount and receipt attachments are optional but typically supplied. Use this when an LLM needs to record a fresh expense on behalf of a worker before it is later attached to an expense report.

Input Parameters

string
required
Transaction date for the expense entry (YYYY-MM-DD).
string
Free-form memo to attach to the expense entry.
object
Amount for the expense entry (Workday Currency object — typically {"value": <amount>, "currency": {"id": <WID>}}).
string
Name of the merchant for the expense entry.
object
A Workday instance reference (id / descriptor / href).
array
Optional list of attachments (e.g. receipt images) to associate with the new entry.
object
required
Reference to the expense item (category) this Quick Expense charges to.
boolean
Whether the entry should be flagged as having an OCR-scanned receipt image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_EXPENSE_ENTRY_ATTACHMENTCreates a new attachment (e.g. receipt image) on an existing expense entry in Workday Expense v1. Workday enforces a 32 MB maximum file size; the file content is sent base64-encoded in attachmentContent. Use this when an LLM workflow needs to attach evidence (a scanned receipt, a PDF invoice) to a previously created Quick Expense.

Input Parameters

string
required
The Workday ID of the expense entry the attachment is being added to.
string
File name of the attachment (e.g. ‘receipt-2026-05-23.jpg’).
integer
File length of the attachment in bytes.
object
MIME content-type reference for an attachment.
string
Base64-encoded attachment content (RaaS / Reports as Web Services form).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_EXPENSE_REPORTCreates a new expense report in Workday Expense v1. A report acts as the container for one or more expense report lines (which can in turn be backed by Quick Expenses, credit card transactions, or travel booking records). Use this as the first step in a “build → fill → submit” expense workflow. Use Create Expense Report Line to populate lines, then Submit Expense Report to send it for approval.

Input Parameters

object
required
Worker who will be reimbursed by this expense report.
object
Company reference for the expense report.
object
Worktag reference (cost center, project, etc.) for the expense report.
string
Creation date of the expense report (YYYY-MM-DD). Defaults to today when omitted.
string
Free-form memo / label for the expense report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_EXPENSE_REPORT_LINECreates an expense report line on an existing expense report in Workday Expense v1. Lines can be created directly with date / expense item / amount, or by referencing an existing Quick Expense, credit card transaction, or travel booking record to inherit its values. Use this after Create Expense Report to populate the report’s lines before submitting it for approval.

Input Parameters

string
required
The Workday ID of the expense report to add the line to.
string
Date the expense report line was created (YYYY-MM-DD).
string
Free-form memo for the expense report line.
object
Expense item (category) reference for a report line.
object
Total amount to be reimbursed for this line (Workday Currency object — typically {"value": <amount>, "currency": {"id": <WID>}}).
object
Reference to an existing Quick Expense entry that backs this line.
object
Reference to a travel booking record that backs this line.
object
Reference to an existing credit card transaction that backs this line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_HOME_CONTACT_CHANGE_ADDRESSCreates a new address staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Home Address, Self-Service: Home Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Address Reference
string
City
object
The usage field.
object
The country field.
string
City - Local
string
Postal Code
object
The countryCity field.
string
Address Line 1
string
Address Line 2
string
Address Line 3
string
Address Line 4
string
Address Line 5
string
Address Line 6
string
Address Line 7
string
Address Line 8
string
Address Line 9
object
The countryRegion field.
integer
Number of Days WFH
string
City Subdivision 1
string
City Subdivision 2
string
Local Address Line 1
string
Local Address Line 2
string
Local Address Line 3
string
Local Address Line 4
string
Local Address Line 5
string
Local Address Line 6
string
Local Address Line 7
string
Local Address Line 8
string
Local Address Line 9
string
Region Subdivision 1
string
Region Subdivision 2
string
City Subdivision 1 - Local
string
City Subdivision 2 - Local
string
Region Subdivision 1 - Local

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_HOME_CONTACT_CHANGE_EMAIL_ADDRESSCreates a new email address staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Home Email, Self-Service: Home Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Email Reference
object
The usage field.
string
The display name of the instance
string
The email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_HOME_CONTACT_CHANGE_INSTANT_MESSENGERCreates a new instant messenger staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Instant Messenger Reference
object
required
Reference to the Workday Instant Messenger Type. Required by the upstream API — omitting it returns A598 ‘You must provide an Instant Messenger Type.’
object
The usage field.
string
The instant messenger account username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_HOME_CONTACT_CHANGE_PHONE_NUMBERCreates a new phone number staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Home Phone, Self-Service: Home Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Phone Reference
object
The usage field.
string
The phone extension.
string
The display name of the instance
object
The deviceType field.
object
The countryPhoneCode field.
string
The complete phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_HOME_CONTACT_CHANGE_WEB_ADDRESSCreates a new web address staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Home Web Address, Self-Service: Home Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Web Address Reference
string
The complete URL address for the web address.
object
The usage field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_JOB_CHANGE_WORKERInitiates a job change request for a worker with an effective date and optional reason, supervisory organization, job, location, and template references. The job change must be submitted separately for changes to persist.

Input Parameters

string
required
The Workday ID of the worker for whom to create the job change.
object
Job reference object for assigning a specific job to the worker.
string
required
Effective date of the job change in YYYY-MM-DD format. Must be a valid date for the job change operation.
object
Job change reason reference object with id property. Must be a valid job change reason ID.
object
Location reference object for assigning a work location.
object
Template reference object with id property for pre-populating job change fields.
string
Optional descriptor or label for the job change instance.
object
Supervisory organization reference object with id property. Must be active on the effective date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_MENTORSHIP_FOR_MECreates a mentorship for the current processing worker, who is set as the mentee. Use when a worker wants to self-create a mentorship with a chosen mentor and type.

Input Parameters

object
required
The mentor worker reference. Required.
string
Comment for the event record.
string
Proposed end date for the mentorship (YYYY-MM-DD).
string
Proposed purpose for the mentorship (rich text).
string
required
Proposed start date for the mentorship (YYYY-MM-DD). Required.
object
required
The mentor type reference. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_MENTORSHIP_FOR_WORKERCreates a new mentorship between two workers. Use when a manager or admin needs to set up a mentor / mentee relationship; if Manage Mentorship has an approval step, the mentorship is not created until the mentorship event is approved.

Input Parameters

object
required
The mentee worker reference. Required.
object
required
The mentor worker reference. Required.
string
Comment for the event record.
string
Proposed end date for the mentorship (YYYY-MM-DD).
string
Proposed purpose for the mentorship (rich text).
string
required
Proposed start date for the mentorship (YYYY-MM-DD). Required.
object
required
The mentor type reference. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_MESSAGE_TEMPLATECreates a new message template. Use when configuring a new notification template (e.g. a hiring email or push notification) that other Workday processes will reference by ID. Workday returns the newly created template including its assigned ID.

Input Parameters

string
required
Message Template name (required).
boolean
Indicates whether the template is active or has been disabled.
string
A preview of the instance.
object
Container for push notification data, used in REST API.
object
Email Configuration container for REST API.
string
The Reference ID to use for lookups within Workday Web Services.
object
required
Notification Type indicates where the template can be used (required).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_ORGANIZATION_ASSIGNMENT_CHANGECreates a new change organization assignment event for a specific filled or unfilled position. Returns a new change organization assignment ID that must be supplied in subsequent requests (sub-resource GETs / PATCHes, and POST /submit) that update or fetch information about this event. Use this action to initiate an organization assignment change (move a worker between business units, companies, cost centers, regions, etc.) before submitting it.

Input Parameters

string
required
The effective date of the business process event in YYYY-MM-DD format. Required.
object
required
Position reference for which to create the change organization assignment event. Provide an instance reference with the Workday position ID (e.g., {‘id’: ‘<wid>’}). Can be a filled or unfilled position. Required.
string
Optional display name of the instance.
object
Optional mass-action header reference object (e.g., {‘id’: ‘<wid>’}).
object
Optional mass-action worksheet reference object (e.g., {‘id’: ‘<wid>’}).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_ORGANIZATION_GOALCreates an organization goal via the Workday Performance Enablement REST API using a free-form JSON body. Secured by Worker Data: Organization Goals and the Performance Enablement scope.

Input Parameters

object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_PAYROLL_INPUTSCreates a single payroll input for a worker and pay component, with a start date and input details. A position-based pay component requires a position, and a one-time input requires an end date.

Input Parameters

object
required
The worker for whom the payroll input is being created.
string
Comment for the payroll input.
string
The end date for the payroll input, using the date format yyyy-mm-dd. Required for one-time payroll inputs.
boolean
Whether the payroll input is ongoing (recurring) or one-time.
object
Reference to a currency in Workday
object
Reference to a position in Workday
array
List of worktags for the payroll input.
string
required
The start date for the payroll input, using the date format yyyy-mm-dd.
boolean
Whether this is an adjustment to an existing payroll input.
array
required
List of input details for the payroll input.
object
required
The pay component for the payroll input.
array
List of run categories for the payroll input.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_PROSPECTCreate one Workday Recruiting prospect with a validated name and either an email address or complete phone details. Name components beyond this action’s minimum depend on the tenant’s Recruiting Name Components configuration. Referral attribution is optional; setting referredBy requires source to identify the tenant’s configured Referral source. This creates the prospect record only and does not initiate the Refer a Candidate business process.

Input Parameters

object
Configured prospect type reference.
object
Target management level reference.
object
Configured prospect source reference. When referredBy is set, this ID must be the tenant’s configured Referral source. Recruiting v4 has no standard endpoint for discovering that ID; obtain it from tenant Recruiting setup or an authorized tenant report.
object
Configured prospect status reference.
object
required
Candidate name and contact details required to create the prospect.
object
Worker reference for the person who referred the candidate.
array
Active candidate tag references.
array
Active static candidate pool references.
Whether the candidate agrees to be contacted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_PROSPECT_EDUCATIONCreates an education entry for the specified prospect. Adds a single education (candidateEducationDetails) instance under the prospect. Workday requires schoolName at minimum. Scope: Recruiting. Secured by: Create External Prospects.

Input Parameters

string
required
The Workday ID of the prospect to attach the education entry to.
object
The degree instance reference obtained by the candidate (e.g., {‘id’: ‘<degree-wid>’}).
string
The name of the school the candidate attended or is attending. Required by Workday.
object
The field of study instance reference (e.g., {‘id’: ‘<field-of-study-wid>’}).
string
The candidate’s grade average at this educational institution.
string
The last year the candidate attended this educational institution.
string
The first year the candidate attended this educational institution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_PROSPECT_EXPERIENCECreates a work experience entry for the specified prospect. Adds a single experience (prospectExperienceDetails) instance under the prospect. Workday requires companyName, title, and startYear at minimum. Scope: Recruiting. Secured by: Create External Prospects.

Input Parameters

string
required
The Workday ID of the prospect to attach the work experience entry to.
string
The business title for the candidate’s work experience. Required by Workday.
string
The year the candidate ended employment at this company.
integer
The month (1-12) the candidate ended employment at this company.
string
The location of this company.
string
The year the candidate started employment at this company. Required by Workday.
integer
The month (1-12) the candidate started employment at this company.
string
The company name the candidate entered in their job history. Required by Workday.
string
Any responsibilities or accomplishments the candidate gained at the associated company.
boolean
If true, the candidate currently works at this company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_PROSPECT_SKILLCreates a skill entry for the specified prospect. Adds a single skill (candidateSkillItemDetails) instance under the prospect. Workday requires name at minimum. Scope: Recruiting. Secured by: Create External Prospects.

Input Parameters

string
required
The Workday ID of the prospect to attach the skill to.
string
The name of the candidate skill. Required by Workday.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_REFERENCE_LETTER_FOR_WORKERInitiate Workday Human_Resources v46.2 Create_Reference_Letter_for_Worker for a tenant-enabled worker and reference-letter template. Uses the single Reference Letter Request business process with configured approvals intact.

Input Parameters

string
required
Workday identifier for the worker receiving the letter.
string
Optional Workday document language identifier for the generated letter.
string
required
Tenant-defined reference-letter template identifier. The template must be active and available to the caller; it is never inferred or hardcoded.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Official Workday WorkerObject identifier type used for worker_id.
string ("WID" | "User_Language_ID")
Official Workday User_LanguageObject identifier type.
string ("WID" | "Reference_Letter_Template_ID")
Official Workday Reference_Letter_TemplateObject identifier type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_REQUESTCreates a new request with the given data. Required fields depend on the request type — use the ‘Create Requests’ task in Workday or GET /types/{ID} to discover them. Secured by the processing person’s Initiate access. Note: the Workday spec advertises multipart/form-data, but this action sends JSON because the schema body’s required parts are simple JSON. Use a separate multipart upload action for attachment use cases.

Input Parameters

string
Latest comment for the request event.
string
Request ID (per the ID generator format).
object
A reference to a Workday instance (id only required).
string
Description of the request.
object
required
Type of the request (Workday ID from GET /types).
object
Questionnaire response submission payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_SCORECARD_RESULTCreates a new Scorecard Result instance on Workday’s Compensation v3 API. Use this when initiating an evaluation cycle against an existing Compensation Scorecard — for example, kicking off merit-and-bonus scoring for an employee or team. Secured by: Set Up: Merit and Bonus. Required body fields: compensationScorecard / scorecardID (the scorecard ID returned by Get Compensation Scorecards) and evaluationDate.

Input Parameters

string
Optional Workday ID or Reference ID to assign to the new Scoreset Container; usually omitted so Workday generates one.
string
Optional display-name override for the new Scorecard Result instance.
object
required
Reference to the Compensation Scorecard being evaluated. The id field must be set.
string
required
The date when the Scorecard Result is evaluated. Use the yyyy-mm-dd format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_SUCCESSION_PLANCreates a new succession plan instance for a position. Specify a valid position ID; the position must not already have an active succession plan.

Input Parameters

object
required
The position associated with the succession plan. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_TAX_RATECreates a single company SUI (State Unemployment Insurance) rate. At a minimum, specify companyInstance, stateInstance, startDate, and taxCode; supply applicableRate to override the default authority rate or exempt to mark the company as exempt.

Input Parameters

string
The payroll tax authority EIN (Employer Identification Number) for company tax reporting.
boolean
If true, the SUI rate is exempt.
string
The end date for company tax reporting, in yyyy-mm-dd format.
string
required
The deduction code used for company tax reporting (e.g. the SUI tax code).
string
required
The start date for company tax reporting, in yyyy-mm-dd format.
object
required
The payroll state authority the SUI rate applies to.
string
The tax override rate for company tax reporting, expressed as a decimal string (e.g. ‘0.027’).
object
required
The company the SUI rate applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_TIME_CLOCK_EVENTCreate a worker check-in, check-out, meal, or break event. Requires the Workday Time Tracking scope and access to the Process: Time Clock Event REST API’s security domain. timeEntryCode, project, and projectPlanTask are optional but mutually exclusive. Create any required worker time attestations first, then pass their IDs in workerTimeAttestations.

Input Parameters

object
A writable Workday instance reference.
object
A writable Workday instance reference.
object
A writable Workday instance reference.
object
A writable Workday instance reference.
object
required
Worker for the time clock event.
string
Comment on the event.
object
A writable Workday instance reference.
object
Project reference.
object
A writable Workday instance reference.
string
required
Event local date and time in ISO 8601 format.
object
A writable Workday instance reference.
object
A writable Workday instance reference.
object
required
Time zone for dateTime. Use LIST_TIME_CLOCK_OPTIONS to get eligible IDs.
object
required
Official event type for the punch. Use LIST_TIME_CLOCK_OPTIONS to get IDs.
object
A writable Workday instance reference.
object
A writable Workday instance reference.
object
A writable Workday instance reference.
number
Override rate for the event.
object
A writable Workday instance reference.
object
Time entry code reference.
object
A writable Workday instance reference.
object
Project plan task reference.
object
Additional references keyed by customOrganization01..10 or customWorktag01..15.
array
Optional ID-only references to existing worker time attestations required by the worker’s Time Tracking configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_TIME_OFF_REQUESTCreates a time off request for the specified worker and initiates the business process. Use Get Worker Time Off Details to find valid time off type IDs (e.g., Vacation, Sick Leave) from the worker’s existing time off entries, and Get Current User to get the authenticated worker’s ID. Note: This endpoint works with time off types, not Leave of Absence types.

Input Parameters

string
required
The Workday ID of the worker resource.
array
required
List of time off entries for the request.
string
View name for the time off request event. Leave empty for default view.
object
required
Business process parameters for the time off request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORK_CONTACT_CHANGE_ADDRESSCreates a new address staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Work Address, Self-Service: Work Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Address Reference
string
City
object
The usage field.
object
The country field.
string
City - Local
string
Postal Code
object
The countryCity field.
string
Address Line 1
string
Address Line 2
string
Address Line 3
string
Address Line 4
string
Address Line 5
string
Address Line 6
string
Address Line 7
string
Address Line 8
string
Address Line 9
object
The countryRegion field.
string
City Subdivision 1
string
City Subdivision 2
string
Local Address Line 1
string
Local Address Line 2
string
Local Address Line 3
string
Local Address Line 4
string
Local Address Line 5
string
Local Address Line 6
string
Local Address Line 7
string
Local Address Line 8
string
Local Address Line 9
string
Region Subdivision 1
string
Region Subdivision 2
string
City Subdivision 1 - Local
string
City Subdivision 2 - Local
string
Region Subdivision 1 - Local

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORK_CONTACT_CHANGE_EMAIL_ADDRESSCreates a new email address staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Work Email, Self-Service: Work Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Email Reference
object
The usage field.
string
The display name of the instance
string
The email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORK_CONTACT_CHANGE_INSTANT_MESSENGERCreates a new instant messenger staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Instant Messenger Reference
object
required
Reference to the Workday Instant Messenger Type. Required by the upstream API — omitting it returns A598 ‘You must provide an Instant Messenger Type.’
object
The usage field.
string
The instant messenger account username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORK_CONTACT_CHANGE_PHONE_NUMBERCreates a new phone number staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Work Phone, Self-Service: Work Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Phone Reference
object
The usage field.
string
The phone extension.
string
The display name of the instance
object
The deviceType field.
object
The countryPhoneCode field.
string
The complete phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORK_CONTACT_CHANGE_WEB_ADDRESSCreates a new web address staged by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Person Data: Work Web Address, Self-Service: Work Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Web Address Reference
string
The complete URL address for the web address.
object
The usage field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_ANYTIME_FEEDBACK_EVENTCreates a single feedback given event instance about the specified worker. Use when you need to create this Workday resource via the Performance Enablement REST API. The spec’s request body schema for this op resolves to no documented properties; pass a free-form JSON object via the body field matching Workday’s public field names.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_EXPLICIT_SKILLSSaves the skills a worker has, creating explicit-skill usage instances. Secured by: Self-Service: Skills Scope: Worker Profile and Skills

Input Parameters

string
required
The Workday ID of the worker.
array
Explicit skill usages to save for the worker.
object
Skill item reference (with id) the user is asserting they have.
array
Skill sources that serve as evidence for the skill usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_REQUESTED_FEEDBACK_ON_SELF_EVENTCreates a single self-requested feedback event instance for the specified worker. Use when you need to create this Workday resource via the Performance Enablement REST API. The spec’s request body schema for this op resolves to no documented properties; pass a free-form JSON object via the body field matching Workday’s public field names.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_REQUESTED_FEEDBACK_ON_WORKER_EVENTCreates a single requested feedback event instance for the specified worker. Use when you need to create this Workday resource via the Performance Enablement REST API. The spec’s request body schema for this op resolves to no documented properties; pass a free-form JSON object via the body field matching Workday’s public field names.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_SKILL_ITEMSCreates skill items in bulk for the specified worker. Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills

Input Parameters

string
required
The Workday ID of the worker.
array
The skill items to create for the worker. Each item represents a skill qualification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_TIME_BLOCKCreate one persistent Workday Time Tracking Worked Time block. In/out entries require Workday time-zone references from LIST_WORKED_TIME_OPTIONS; scalar IANA time-zone strings are not accepted by Workday. Reference-based in/out entries default to v5 for compatibility; set api_version=v6 to use v6. The toolkit does not expose a compatible v6 delete action, so obtain explicit confirmation and plan manual tenant cleanup before creating it. For hourly time, provide calendarDate and a positive reportedQuantity. For flat in/out time, provide inTime, outTime, inTimeZone, and outTimeZone; calendarDate is optional. Exactly one timeEntryCode, project, or projectPlanTask is required. Use LIST_WORKED_TIME_OPTIONS to discover eligible references. Requires the Time Tracking scope and Process: Time Block REST APIs security domain.

Input Parameters

object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
string
Comment for the time block.
string
Local ISO 8601 in-time for a flat in/out entry. Required with outTime and both time zones.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
string
Local ISO 8601 out-time for a flat in/out entry. Required with inTime and both time zones.
object
A Workday instance reference accepted for write compatibility.
string
required
Workday ID of the worker, an Employee_ID or Contingent_Worker_ID reference ID, or me.
object
A Workday instance reference accepted for write compatibility.
string ("v5" | "v6")
Time Tracking API version. Reference-based in/out entries default to v5 for compatibility; set v6 to use the v6 endpoint. Hourly entries default to v6.
object
A Workday instance reference accepted for write compatibility.
boolean
Whether project time is non-billable.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
string
Calendar date. Required with reportedQuantity for hourly entries; optional for flat in/out entries.
object
A Workday instance reference accepted for write compatibility.
number
Override rate, when allowed by the time entry code.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
object
A Workday instance reference accepted for write compatibility.
number
Positive hours or units for an hourly Worked Time entry. Omit for in/out entries.
object
A Workday instance reference accepted for write compatibility.
object
Additional customOrganization01 through 10 or customWorktag01 through 15 references.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_CREATE_WORKER_TIME_REVIEW_EVENTCreates a time review event for the specified worker. Typically used by managers / admins to submit time on behalf of workers, or by workers to submit their own time for approval. The date determines whether time is submitted for the pay period or week.

Input Parameters

string
required
The Workday ID of the worker (or ‘me’) for whom to submit time.
string
required
Date (YYYY-MM-DD) used to construct the time review event. Determines whether time is submitted for the pay period or the week.
string
Comment that persists on each time review event. Only allowed if comments are enabled for the Enter Time business process.
array
Time Review Events created in the Submit Time request. Each entry can include worker, dates, and override fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_COMPENSATION_SCORECARDDeletes a Compensation Scorecard with the specified ID from Workday’s Compensation v3 API. Use when retiring an obsolete scorecard template or cleaning up duplicates. Workday rejects the call (HTTP 400) if the scorecard is referenced by existing Scorecard Results. Secured by: Set Up: Merit and Bonus. Workday returns no body on success, so the action surfaces a boolean confirmation plus the deleted ID.

Input Parameters

string
required
The Workday ID of the Compensation Scorecard to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_CUSTOM_OBJECTDeletes a custom object instance. Specify either the extended Workday object ID or the custom object’s own ID. The same endpoint serves both single-instance and multi-instance custom object definitions.

Input Parameters

string
required
Either the extended Workday object ID or the custom object’s own ID.
string
required
The web service alias of the custom object. Determine this by running the ‘View Custom Object’ task in Workday. Works for both single-instance and multi-instance custom object definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_CUSTOM_OBJECT_DEFINITION_CONDITION_RULERemoves a condition rule from a custom object definition. Use this when a previously attached visibility or business-logic rule is no longer needed on the custom object.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the condition rule.
string
required
The Workday ID of the condition rule to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_CUSTOM_OBJECT_DEFINITION_VALIDATIONRemoves a validation from a custom object definition. Use this when a previously attached data-quality check is no longer appropriate for the custom object (for example, when relaxing a required-field rule).

Input Parameters

string
required
The Workday ID of the custom object definition that owns the validation.
string
required
The Workday ID of the validation to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_EXPENSE_ENTRYDeletes a Quick Expense entry from Workday Expense v1 by its Workday Identifier (WID). The entry is permanently removed and cannot be restored through the REST API. Use this only when an entry was created in error or is no longer needed; for entries already attached to a submitted report, deletion may be blocked by Workday’s business rules.

Input Parameters

string
required
The Workday ID of the Quick Expense entry to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_HOME_CONTACT_CHANGE_ADDRESSRemove the specified address. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Home Address, Self-Service: Home Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_HOME_CONTACT_CHANGE_INSTANT_MESSENGERRemove the specified instant messenger. If this instant messenger existed before the start of the current business process, it won’t be removed from the target Person until the parent business process. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_HOME_CONTACT_CHANGE_PHONE_NUMBERRemove the specified phone number. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Home Phone, Self-Service: Home Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_HOME_CONTACT_CHANGE_WEB_ADDRESSRemove the specified web address. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Home Web Address, Self-Service: Home Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_PAYROLL_INPUTDeletes an existing payroll input instance with the specified Workday ID. Use this action to remove a previously created payroll input. The Pay Component Segment Security configuration applies to this operation — callers must have delete permission for the pay component on the input. Workday returns an empty body on success; the action wraps that into a small confirmation payload.

Input Parameters

string
required
The Workday ID of the payroll input instance to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_SCORECARD_RESULTDeletes the Scorecard Result with the specified ID from Workday’s Compensation v3 API. Use when an evaluation needs to be retracted before it has been completed or when cleaning up duplicate / mistaken Scorecard Result instances. Secured by: Set Up: Merit and Bonus. Workday returns no body on success, so the action surfaces a boolean confirmation plus the deleted ID.

Input Parameters

string
required
The Workday ID of the Scorecard Result to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_TIME_CLOCK_EVENTDelete a time clock event by ID. Requires the Workday Time Tracking scope and access to the Process: Delete Time Clock Event REST API’s security domain.

Input Parameters

string
required
Workday ID or Time_Clock_Event_ID reference ID of the event to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_WORK_CONTACT_CHANGE_ADDRESSRemove the specified address. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Work Address, Self-Service: Work Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_WORK_CONTACT_CHANGE_EMAIL_ADDRESSRemove the specified email address. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Work Email, Self-Service: Work Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_WORK_CONTACT_CHANGE_PHONE_NUMBERRemove the specified phone number. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Work Phone, Self-Service: Work Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DELETE_WORK_CONTACT_CHANGE_WEB_ADDRESSRemove the specified web address. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. Use this action when integrating Workday’s person v4 API and you need to delete this specific resource. Secured by: Person Data: Work Web Address, Self-Service: Work Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DENY_BUSINESS_PROCESS_EVENT_STEPDenies the specified business process event step (Approval step type). Use this when an approver decides to deny a step — the business process transitions according to the tenant’s denial routing. The caller must be in the awaiting-person list for the step.

Input Parameters

string
required
The Workday ID of the business process event step to deny.
string
Optional denial comment recorded on the event step.
object
Optional step-action reference object ({id} or {id, descriptor}) selecting which deny variant to perform when multiple are configured on the step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DISCOVER_ONE_TIME_PAYMENT_OPTIONSDiscover a worker’s current primary and additional positions through the Staffing REST v7 worker record so Compensation REST receives its required job IDs. This action is current-state only and accepts no effective date. Retrieve one bounded page of Compensation REST v3 plan-group prompt values for each position, then retrieve actual one-time-payment plan references through Compensation Get_One-Time_Payment_Plans v46.0. If prompt IDs do not match actual plan IDs, return the SOAP plans as tenant candidates rather than mislabeling group WIDs as actionable plans. Results may be truncated; profile currency, worker-plan eligibility, and reason eligibility remain unresolved.

Input Parameters

string
required
Worker Employee ID, 32-character WID, or typed Employee_ID/Contingent_Worker_ID reference used to discover effective positions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_DISCOVER_REFERENCE_VALUESReturn one bounded page of tenant reference values needed by the supported prospect, referral, reference-letter, language, and military workflows using Integrations SOAP v46.2 Get_References. Use response_results to request another page and retain as_of_entry_datetime across pages. Enumeration proves only that a value exists and is visible; it does not prove that the value is active, eligible, or mapped for a particular worker, country, case, business process, or other context.

Input Parameters

integer
One-based page to return, bounded from 1 through 100.
integer
Maximum reference values to return on this page, from 1 through 100.
string ("prospect_source" | "referral_relationship" | "reference_letter_template" | "user_language" | "military_status" | "military_service_type" | "military_rank" | "military_discharge_type")
required
Exact supported workflow value to enumerate. Arbitrary Workday reference ID types are intentionally not accepted.
string
Optional effective date for the reference values.
string
Stable entry timestamp. Required after page 1 and reused across pages.
boolean
Return only values matching the tenant’s default reference ID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ABSENCE_BALANCERetrieves balance information for a specific worker’s absence plan. This action returns balance details including the quantity of hours/days available, the unit of measurement (hours/days), effective date, and related metadata for a worker’s time off or leave of absence plan. Use this to check how much time off a worker has remaining for a specific absence plan at a given point in time.

Input Parameters

string
required
The Workday ID of the worker for which the balance is requested. Can be obtained from ‘Get Current User’ or ‘List Workers’ actions.
string
Date for which to retrieve the balance, in yyyy-mm-dd format (e.g., ‘2024-01-15’). If omitted, retrieves the most recent available balance.
string
required
The Workday ID of the absence plan (e.g., PTO, sick leave, vacation). Can be obtained from ‘List Absence Balances’ action which returns balance objects containing absencePlan IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ABSENCE_MANAGEMENT_WORKERRetrieves a single worker (with current staffing information) as exposed by absenceManagement. Accepts either a worker Workday ID or the literal ‘me’ sentinel for the authenticated user. Use as a prerequisite for absence-specific endpoints that need a worker ID.

Input Parameters

string
required
The Workday ID of the worker, or the literal ‘me’ to refer to the authenticated user. Use List Absence Management Workers to find an ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ADDITIONAL_NAMESRetrieves a collection of additional names for a person. Use this action when you need to fetch multiple name variations (such as local script names, social names, or alternative name forms) associated with a specific person in Workday. This is a read-only operation - it does not modify any data in Workday.

Input Parameters

string
required
The Workday ID of the person resource. Example: ‘WD-12345’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_AND_SET_UP_SCORES_ON_SCORECARD_RESULTSRetrieves an existing scorecard result by ID, including available evaluation date, scorecard details, and profile-specific goals results for performance reviews or compensation assessments.

Input Parameters

string
required
The Workday ID of the scorecard results resource. This is a unique identifier for the scorecard result instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ASSIGNMENT_CHANGE_GROUP_COST_CENTERSRetrieves cost centers instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ASSIGNMENT_CHANGE_GROUP_JOBSRetrieves jobs instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ASSIGNMENT_TYPESRetrieves assignment types instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ATTACHMENT_BUSINESS_PROCESS_EVENTLists attachment metadata for a business process event, including file name, size, content type, uploader and upload date when available. A 404 response is returned as an empty list.

Input Parameters

string
required
The Workday ID of the business process event resource. Format: alphanumeric string (e.g., ‘abc12345-xyz’).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ATTACHMENT_BY_EXTERNAL_IDRetrieves attachment details by external identifier, including file metadata and download URL when available. A 404 response returns the external identifier with other fields empty.

Input Parameters

string
required
The external identifier for the attachment. Example: ‘AT1’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_AUDIENCE_SELECTIONRetrieves the valid audience-selection values for the Audience Prompt Group. Use alongside Get Audience Types when constructing the audience descriptor for a Send Message call: the selection value narrows the chosen audience type to a specific instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_AUDIENCE_TYPESRetrieves the valid audience-type values for the Audience Prompt Group. Use when configuring a message’s recipient-audience filter — pick an ID from here and pass it through to a Send Message call or audience-aware template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_BALANCE_DETAILSRequests balance details for a worker and absence plan, optionally at an effective date. Returns the first balance in the response, or empty fields if no balance is returned.

Input Parameters

string
required
The Workday ID of the worker. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’.
string
Date for which to retrieve the balance, in yyyy-mm-dd format (e.g., ‘2025-12-31’). If omitted, retrieves the most recent available balance.
string
required
The Workday ID of the absence plan (e.g., PTO, sick leave, vacation). This can be obtained from ‘List Balances’ action which returns balance objects with absencePlan IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_BUSINESS_PROCESSRetrieves a business process event by its ID. Returns the status, current step, workflow steps, initiator, and subject information for the event.

Input Parameters

string
required
The Workday ID of the business process event to retrieve. This is a unique identifier for the specific business process event (e.g., ‘test123’ or ‘11111111111111111111111111111111’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_BUSINESS_PROCESS_EVENT_STEPRetrieves a single business process event step by its ID. Use this for a full per-step view (status, due date, assignees, questionnaire/task references, completion metadata). Returned results are secured by the caller’s view access to the parent event; lack of access surfaces as a 404.

Input Parameters

string
required
The Workday ID of the business process event step to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_BUSINESS_PROCESS_TYPERetrieves a single business process type by its Workday ID. Use this to look up the descriptor and initiation help text for a specific business process definition (e.g., ‘Hire’, ‘Change Job’).

Input Parameters

string
required
The Workday ID of the business process type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_BUSINESS_TITLE_CHANGERetrieves a business title change instance by ID from the Workday Common API v1. Use this action when you need to fetch detailed information about a specific business title change request, including its subject worker, proposed vs current titles, and effective/initiated timestamps.

Input Parameters

string
required
The Workday ID of the business title change instance. Example: ‘11111111111111111111111111111111’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_BUSINESS_TITLE_CHANGE_FOR_WORKERRetrieves a business title change instance for a specific worker from the Workday Common API v1. Use when you need detailed information about a particular business title change event scoped to a worker.

Input Parameters

string
required
The Workday ID of the worker whose business title change you want to retrieve.
string
required
The Workday ID of the business title change subresource (the specific business title change instance) for the worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CASERetrieves a Help case with the specified ID. Returns case details including title, detailed message, case ID, status, creation date, case link, assignee, confidentiality flag, about, by, for, type, and service team.

Input Parameters

string
required
The Workday ID of the case to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CASE_TYPERetrieve one Workday Help case type visible to the processing worker. Preserves questionnaire.id when present, but that reference is not questionnaireHolder and does not provide the questionnaire’s full question-and-answer schema.

Input Parameters

string
required
The Workday ID of the case type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CERTIFICATION_ISSUERSRetrieves certification issuer records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CERTIFICATIONSRetrieves certification records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CHECK_INSRetrieves check in records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CHECK_IN_TOPICSRetrieves check in topic records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COLLECTION_OF_PAYROLLRetrieves a collection of payroll inputs. At least 1 query parameter is required to get data. The Pay Component Segment Security configuration doesn’t apply to the GET method. Self-service users can view all of their own Payroll Inputs.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
array
The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service.
string
The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd (e.g., ‘2026-12-31’).
string
The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd (e.g., ‘2026-01-01’). At least one query parameter is required to get data.
array
The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPANIES_VALUESRetrieves company instances that can be used as values for other endpoint parameters in the Workday Staffing service (Organization Assignment Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPANY_INSIDER_TYPESRetrieves company insider types instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPENSATION_SCORE_CARD_INFORetrieves a Workday compensation scorecard by ID, including available goals, profiles, eligibility rules, effective date, and status. Requires the Advanced Compensation scope.

Input Parameters

string
required
The Workday ID of the scorecard resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPENSATION_SCORECARDSLists Workday compensation scorecards, including available goals, profiles, and effective dates. Filter by effective date and paginate using limit and offset; the page size is at most 100. Requires the Advanced Compensation scope.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Effective date the scorecard task takes effect. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPETENCIESRetrieves competency records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPETENCY_CATEGORIESRetrieves competency category records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
string
Optional Competency Category reference identifier.
string
Identifier type for competency_category_id.
array
Optional additional Competency Category references to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COMPLETED_STEPS_BUSINESS_PROCESSRetrieves completed steps for a business process event by ID, including available completion dates, status, completed-by person, and comments. Use limit and offset to page through the history; the maximum page size is 100. An HTTP 404 returns an empty list with total zero.

Input Parameters

string
required
The Workday ID of the business process event. This is a unique identifier for the specific business process instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CONTINGENT_WORKER_TYPESRetrieves contingent worker types instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COUNTRIESRetrieves a collection of information about countries from Workday. Use this action when you need to list all available countries with their metadata including ISO codes and address lookup settings. The response includes country identifiers, human-readable names, ISO codes (alpha-2 and alpha-3 formats), and whether each country is enabled for address lookup functionality.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COUNTRY_ADDRESS_COMPONENTSRetrieves the allowed address components and their configuration for the Country and a given Address Configuration Format. The webServiceAlias of the returned address components map to the enterable fields when submitting address data in other POST/PUT/PATCH operations. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
The existing address being updated. Required when you use Default Format and a Country using Local Script to get component data for an existing address. Failure to provide this when appropriate may result in incorrect address component data being returned.
boolean
When applicable, setting this value to false will enable Local Script components only. Local Components that are requireable will be enforced as required. When set to true, Local Script and Western Script components are enabled. Western Script Components that are requireable will be enforced as required.
string
The Address Configuration Format to return values for. Required. Failure to provide this will result in no address components being returned. Available values are: - DEFAULT_AREAS - RECRUITING_FORMAT

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_COUNTRY_INFORetrieves detailed information about a specific country from Workday. Use this to get country metadata including ISO codes and address lookup settings.

Input Parameters

string
required
The Workday ID of the country resource. This is a unique identifier for the country in Workday’s system. Example: ‘00000000000000000000000000000033’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CURRENCIESRetrieves currencies instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CURRENCYRetrieves the details of a specified currency from Core Accounting (id, descriptor, code, precision). Use to resolve a currency WID into its readable code/precision data.

Input Parameters

string
required
The Workday ID of the currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CURRENT_USERRetrieves the current authenticated worker’s profile information from Workday.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_FIELD_TYPERetrieves a custom field type by ID, returning its ID, display descriptor and API link when available.

Input Parameters

string
required
The Workday ID of the custom field type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_FIELD_TYPE_LIST_VALUERetrieves a specific list value for a custom list field type used by a custom object definition. Use this when you need to inspect a single option’s metadata before updating or deactivating it.

Input Parameters

string
required
The Workday ID of the custom field type (custom list) that owns the list value.
string
required
The Workday ID of the list value to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_OBJECTRetrieves a custom object instance by ID. Specify either the extended Workday object ID or the custom object’s own ID. The same endpoint serves both single-instance and multi-instance custom object definitions; the custom object’s underlying definition determines the response shape.

Input Parameters

string
required
Specify either the extended Workday object ID (the business object the custom object is attached to, e.g. a worker’s WID) or the custom object instance’s own ID.
string
required
The web service alias of the custom object. Determine this by running the ‘View Custom Object’ task in Workday. Works for both single-instance and multi-instance custom object definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_OBJECT_DEFINITIONRetrieves a single custom object definition (either multi-instance or single-instance) by Workday ID. Use this when you need the high-level metadata of a custom object — its name, alias, active state, extended business object, and any optional business-object filter — before drilling into its fields, validations, or condition rules.

Input Parameters

string
required
The Workday ID of the custom object definition to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_OBJECT_DEFINITION_CONDITION_RULERetrieves a single condition rule attached to a custom object definition, returning its ID, descriptor, and resource URL when available.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the condition rule.
string
required
The Workday ID of the condition rule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_OBJECT_DEFINITION_FIELDRetrieves a single field belonging to a custom object definition, returning its ID, descriptor, and resource URL when available.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the field.
string
required
The Workday ID of the field to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_CUSTOM_OBJECT_DEFINITION_VALIDATIONRetrieves a single validation attached to a custom object definition by its ID. The response exposes its ID, descriptor, and resource link.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the validation.
string
required
The Workday ID of the validation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_DEGREESRetrieves degree records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EMPLOYEE_COMPENSATIONRetrieves a worker instance from the Workday Compensation v3 API. Returns the worker profile (display name, business title, primary email/phone, primary work address, primary supervisory organization, location, years of service, and manager flag) as exposed by the compensation surface’s /workers/{ID} endpoint.

Input Parameters

string
required
The Workday ID of the worker for whom to retrieve profile information. Can be obtained from ‘Get Worker Info’ or ‘Get Current User’ actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EMPLOYEE_ENROLLMENT_EVENTRetrieves a benefit enrollment event for the processing worker by enrollment event ID.

Input Parameters

string
required
The Workday ID of the employee enrollment event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EMPLOYEE_REVIEWSExports in-progress and completed employee reviews from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of employee reviews to return in this page. Workday supports values from 1 through 999.
string
Optional employee review identifier. Omit to retrieve a paginated set of in-progress and completed employee reviews.
string
Optional effective date filter in YYYY-MM-DD format. If omitted, Workday defaults to today’s effective date.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00. Use this with page when stable pagination across requests is required.
string ("WID" | "Employee_Review_ID")
Identifier type for employee_review_id. Use WID for Workday IDs and Employee_Review_ID for reference IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EMPLOYEE_REVIEW_TEMPLATESRetrieves employee review template records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
string
Optional Employee Review Template reference identifier.
string
Identifier type for employee_review_template_id.
array
Optional additional Employee Review Template references to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EMPLOYEE_TYPESRetrieves employee type instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EXPENSE_ENTRYRetrieves a single Quick Expense entry from Workday Expense v1 by its Workday Identifier (WID), returning merchant, memo, amount, status, and any attached OCR receipt metadata. Use this when an LLM needs to read or summarise a specific expense entry before deciding whether to update, delete, or attach it to a report.

Input Parameters

string
required
The Workday ID of the Quick Expense entry to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EXPENSE_ITEMRetrieves details of an Expense Item referenced by its Workday Identifier (WID). Expense items are the spend categories (meals, mileage, lodging, …) that an entry or report line can be charged against. Use this to confirm an expense item’s display name before assigning it to a Quick Expense or expense report line.

Input Parameters

string
required
The Workday ID of the expense item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_EXPENSE_REPORTRetrieves details of a Workday Expense Report by its Workday Identifier (WID). Returns the report’s memo, creation date, status reference, and total amount, along with the standard id/descriptor/href instance fields.

Input Parameters

string
required
The Workday Identifier (WID) of the expense report to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_FEEDBACK_BADGE_BY_IDRetrieves a Feedback Badge with the specified ID. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

string
required
The Workday ID of the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_FEEDBACK_BADGESRetrieves feedback badge records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_FEEDBACK_QUESTIONSRetrieves feedback question records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
string
Optional Feedback Question reference identifier.
string
Identifier type for feedback_question_id.
array
Optional additional Feedback Question references to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_FIELDS_OF_STUDYRetrieves field of study records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_GIFTSRetrieves gift (organization) instances that can be used as values for other endpoint parameters in the Workday Staffing service (Organization Assignment Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_GIVE_REQUESTED_FEEDBACK_EVENT_BY_IDRetrieves a requested feedback event by event ID through the Workday Performance Enablement API. The response exposes the event’s ID, descriptor, and link.

Input Parameters

string
required
The Workday ID of the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_GOAL_PAYOUT_BANDSRetrieves goal payout band records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_GOAL_UNITSRetrieves goal unit records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_GRANTSRetrieves grants instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_GRAPH_API_VERSIONRetrieves a single supported Workday Graph API version by ID. Use this when you already know a version’s Workday ID and need to fetch its details.

Input Parameters

string
required
The Workday ID of the Graph API version resource to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HEADCOUNT_OPTIONSRetrieves headcount options instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HISTORY_ITEMS_FOR_WORKERRetrieves the collection of history items (business processes / employment changes) for a specific worker from the Workday Common API v1. Use when you need to access a worker’s staffing history, completed/in-flight business processes, or audit trail of employment events.

Input Parameters

string
required
The Workday ID of the worker. Can be obtained from actions like ‘Get Current User’ or ‘List Workers’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOLIDAY_EVENTSReturns the holiday events for the specified workers and time period.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
The end date of the date range filter in yyyy-mm-dd format (e.g., ‘2026-12-31’). Returns holiday events on or before this date. Can be used alone or with fromDate.
array
Array of worker IDs to filter holiday events for specific workers.
string
The start date of the date range filter in yyyy-mm-dd format (e.g., ‘2026-01-01’). Returns holiday events on or after this date. Can be used alone or with toDate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_ADDRESSAn address as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Address, Self-Service: Home Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_EMAIL_ADDRESSAn email address as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Email, Self-Service: Home Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_EMAIL_ADDRESSESRetrieve a page of email addresses staged for update by a Home Contact Change business process event, with optional filters and pagination. Secured by Person Data: Home Email and Self-Service: Home Email; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public email addresses.
boolean
If true, returns only the IDs of the person’s primary email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_EVENT_INFORMATIONRetrieves basic information about a Home Contact Change event by its ID. Use this action when you need to fetch details about a specific Home Contact Change business process event, including the event ID, descriptor, and associated business process parameters. This is a read-only operation that queries existing event data.

Input Parameters

string
required
The Workday ID of the Home Contact Change event resource. This is typically a WID format identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_INSTANT_MESSENGERAn instant messenger as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_INSTANT_MESSENGERSRetrieve a page of instant messengers staged for update by a Home Contact Change business process event, with optional filters and pagination. Secured by Person Data: Home Instant Messenger and Self-Service: Home Instant Messenger; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public instant messenger account usernames.
boolean
If true, returns only the IDs of the person’s primary instant messenger account usernames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_PHONE_NUMBERA phone number as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Phone, Self-Service: Home Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_PHONE_NUMBERSRetrieves a page of phone numbers staged for update by the parent business process in Workday’s person v4 API, with optional filters. Secured by Person Data: Home Phone and Self-Service: Home Phone; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public phone numbers.
boolean
If true, returns only the IDs of the person’s primary phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_WEB_ADDRESSA web address as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Web Address, Self-Service: Home Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_CHANGE_WEB_ADDRESSESRetrieves a page of web addresses staged for update by the parent business process in Workday’s person v4 API, with optional filters. Secured by Person Data: Home Web Address and Self-Service: Home Web Address; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public web addresses.
boolean
If true, returns only the IDs of the person’s primary web addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_CONTACT_INFORMATION_CHANGERetrieves an existing Home Contact Change event for the worker’s Person. Secured by: Change Home Contact Information (REST Service) Scope: Contact Information

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the Home Contact Change event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_HOME_WEB_ADDRESSESRetrieves a collection of home web addresses for a person. Use this action when you need to get home web addresses associated with a person in Workday.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping.
boolean
If true, returns only the IDs of the person’s public web addresses.
boolean
If true, returns only the IDs of the person’s primary web addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_IMPORT_PROCESSESRetrieves the status and completion details of a Workday import process.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
required
The import process runtime identifier returned by an asynchronous Workday import operation, such as Import Employee Reviews.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-13T00:00:00. Provide this when paging to keep the result set stable between requests.
string ("WID" | "Background_Process_Instance_ID")
Identifier type for import_process_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_IMPORT_PROCESS_MESSAGESRetrieves errors, warnings, and details emitted by a Workday import process.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
required
The import process runtime identifier returned by an asynchronous Workday import operation, such as Import Employee Reviews.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-13T00:00:00. Provide this when paging to keep the result set stable between requests.
string ("WID" | "Background_Process_Instance_ID")
Identifier type for import_process_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_IN_PROCESS_STEPS_BUSINESS_PROCESS_EVENTRetrieves in-progress steps for a business process event by ID, including available step names, statuses, assignees, and due dates. Use limit and offset to page through the results; the maximum page size is 100. An HTTP 404 returns an empty list with total zero.

Input Parameters

string
required
The Workday ID of the business process event. This is a unique identifier for the specific business process instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_INTERVIEWRetrieves a single interview event by ID, including job requisition, job application, interviewers, statuses, and feedback metadata. Scope: Recruiting. Secured by: Interview Feedback Public API.

Input Parameters

string
required
The Workday ID of the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_INTERVIEW_FEEDBACKRetrieves a page of feedback entries for a specified Workday Recruiting interview, with extracted overall ratings and comments. Supports limit and offset; the feedback count reflects the entries returned in that page.

Input Parameters

string
required
The Workday Interview ID (WID) - a unique identifier for the interview. This can be obtained from the List Interviews action. Format: 32-character alphanumeric string.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_INTERVIEW_FEEDBACK2Retrieves a page of interview feedback for a specified Workday Recruiting interview, including modeled ratings, comments, and recommendations when available. Supports limit and offset.

Input Parameters

string
required
The Workday Interview ID (WID) - a unique identifier for the interview. This can be obtained from the List Interviews action. Format: 32-character alphanumeric string.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_BY_IDTool to retrieve detailed information about a single job instance by its ID. Use when you need to fetch specific job details including business title, job profile, job type, location, supervisory organization, and assigned worker information.

Input Parameters

string
required
The Workday ID of the job resource. This is a unique identifier for the job instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGE_FREQUENCIESRetrieves frequencies instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGE_LOCATION_INFOTool to retrieve location information for a specific job change in Workday. Use when you need details about the work location, scheduled hours, work shift, or workspace associated with a job change event.

Input Parameters

string
required
The Workday ID of the job change resource. This is a unique identifier for a specific job change event.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGE_REASONRetrieves a job change reason instance from the Workday Common API v1. Use when you need to get details about a specific job change reason, such as whether it applies to employees, contingent workers, or can be entered by managers, before using it in job change or business title change operations.

Input Parameters

string
required
The Workday ID of the job change reason resource. A 32-character hexadecimal string (e.g., ‘00000000000000000000000000000024’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGE_REASON_VALUESRetrieves job change reasons instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_ADMINISTRATIVERetrieves the administrative options for the specified job change ID. Use when you need to inspect administrative details (FTE, hours, worker type, notification date, end employment date, etc.) associated with a Workday Staffing job change event.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_ADMINISTRATIVE_BY_IDRetrieves the administrative options for the specified job change ID using the subresource path. Use when you need a specific administrative-details record (FTE, hours, worker type, end employment date, etc.) for a Workday Staffing job change. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change.
string
required
The Workday ID of the administrative subresource. For singleton subresources like administrative, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_BUSINESS_TITLERetrieves the business title for the specified job change ID. Use when you need to get the business title information associated with a specific job change event in Workday Staffing API.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_BUSINESS_TITLE_BY_IDRetrieves the business title for the specified job change ID using the subresource path. Use when you need to read the business title of an in-progress Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change.
string
required
The Workday ID of the businessTitle subresource. For singleton subresources like businessTitle, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_BY_IDRetrieves a single change job event instance by its ID. Use when you need to fetch detailed information about a specific job change event in Workday, including the worker, position, business title, effective date, and status.

Input Parameters

string
required
The Workday ID of the job change resource. This is a unique identifier for the job change event instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_COMMENT_BY_IDReturns the comment information for the specified job change ID. Use when you need to retrieve comments associated with a specific job change event in Workday Staffing API. This action is read-only and does not modify any data.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change (e.g., ‘00000000000000000000000000000022’).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_COMMENT_BY_SUBRESOURCE_IDReturns the comment information for the specified job change ID using the subresource path. Use when you need a specific comment for an in-progress Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change.
string
required
The Workday ID of the comment subresource. For singleton subresources like comment, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_CONTRACTRetrieves the contract options for the specified job change ID. Use when you need to inspect contract details (end date, assignment details, pay rate, currency, purchase order, frequency) associated with a Workday Staffing job change event.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_CONTRACT_OPTIONSRetrieves the contract options for a specific job change in Workday Staffing API. Use when you need to get contract information associated with a job change event, including pay rate, currency, frequency, and purchase order details.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change (e.g., ‘00000000000000000000000000000015’).
string
required
The Workday ID of the contract subresource. This is a 32-character hexadecimal string that identifies the specific contract within the job change (e.g., ‘WID-987654321’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_GROUP_TEMPLATESRetrieves templates instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_JOB_CLASSIFICATIONRetrieves the job classification entries for the specified job change ID. Use when you need to inspect additional job classifications proposed by a Workday Staffing job change event.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_JOB_CLASSIFICATION_BY_IDRetrieves a job classification for the specified job change ID using the subresource path. Use when you need the additional job classifications attached to an in-progress Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
required
The Workday ID of the jobClassification subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_JOB_PROFILERetrieves a job profile for the specified job change ID. Use when you need to get job profile details including job profile data and job titles associated with a job change event in the Workday Staffing API.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change (e.g., ‘00000000000000000000000000000015’).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_JOB_PROFILE_BY_IDRetrieves a job profile for the specified job change ID using the subresource path. Use when you need the proposed job profile and job title for an in-progress Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
required
The Workday ID of the jobProfile subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_JOB_VALUESRetrieves jobs instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_LOCATION_BY_IDReturns the location information for the specified job change ID using the subresource path. Use when you need workspace, work shift, location, and scheduled hours for an in-progress Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
required
The Workday ID of the location subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_MOVE_TEAMRetrieves the move-team options for the specified job change ID. Use when you need to inspect whether the manager’s reporting teams moved as part of a Workday Staffing job change event.

Input Parameters

string
required
The Workday ID of the job change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_MOVE_TEAM_BY_IDRetrieves a move-team option from the specified job change ID using the subresource path. Use when you need the move-team flag for an in-progress Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
required
The Workday ID of the moveTeam subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_OPENING_OPTIONSRetrieves the opening options for the specified job change ID in Workday Staffing API. Use when you need to get available headcount opening options associated with a job change instance, including whether openings are available for overlap.

Input Parameters

string
required
The Workday ID of the job change resource. This is a unique identifier for the job change instance.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_OPENING_OPTIONS2Retrieves the opening options for the specified job change ID. Use when you need to get details about specific opening options available within a job change event in the Workday Staffing API. This action retrieves detailed information about an opening subresource within a job change, including whether the opening is available for overlap and associated headcount options.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change (e.g., ‘00000000000000000000000000000015’).
string
required
The Workday ID of the opening subresource. This is a 32-character hexadecimal string that identifies the specific opening within the job change (e.g., ‘00000000000000000000000000000015’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_POSITION_BY_IDRetrieves positions for a specified job change ID in Workday Staffing API. Use when you need to get position information associated with a job change event, including whether positions are being created, closed, or available for overlap. Supports pagination via limit and offset parameters.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change (e.g., ‘00000000000000000000000000000015’).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_POSITION_BY_SUBRESOURCE_IDRetrieves a position for the specified job change ID using the Workday Staffing API. Use this action when you need to get position information associated with a job change event, including whether the position is being created, closed, or available for overlap.

Input Parameters

string
required
The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change (e.g., ‘00000000000000000000000000000015’).
string
required
The Workday ID of the position subresource. This is a 32-character hexadecimal string that identifies the specific position within the job change (e.g., ‘00000000000000000000000000000113’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_START_DETAILSRetrieves the start details for the specified job change ID. Use when you need the effective date, reason, location, supervisory organization, worker, job, and template details associated with a Workday Staffing job change event.

Input Parameters

string
required
The Workday ID of the job change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_START_DETAILS_BY_IDRetrieves the start details for the specified job change ID using the subresource path. Use when you need a specific start-details record (effective date, reason, location, supervisory org, worker, job, template) for a Workday Staffing job change event. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
required
The Workday ID of the startDetails subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CHANGES_WORKER_VALUESRetrieves workers instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_CLASSIFICATIONSRetrieves job classifications instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_FAMILYRetrieves a single job family instance with the specified Workday ID from the Staffing service.

Input Parameters

string
required
The Workday ID of the job family resource to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_POSTINGRetrieves detailed information about a specific job posting including job description.

Input Parameters

string
required
The unique Workday ID of the job posting. This ID can be obtained from the LIST_JOB_POSTINGS or GET_MY_JOB_POSTINGS actions. Example format: ‘JOB-12345’ or a UUID-style identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_POSTING_CANDIDATE_AVAILABILITY_TEMPLATERetrieves the candidate availability template versions for the active job posting with the specified ID. Use this when you need to inspect candidate self-scheduling slots that have been associated with a job posting. Scope: Recruiting. Secured by: Job Postings: External.

Input Parameters

string
required
The Workday ID of the resource (job posting).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_POSTING_QUESTIONNAIRERetrieves screening questions and questionnaires associated with a specific job posting.

Input Parameters

string
required
The Workday ID of the job posting resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
array
Filter questionnaires by type (e.g., screening, pre-hire). Accepts multiple types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_POSTING_QUESTIONNAIRE_BY_IDRetrieves a single questionnaire for the specified job posting ID. Resolves the questionnaire subresource by its ID under the given job posting. Scope: Recruiting. Secured by: Job Postings: External.

Input Parameters

string
required
The Workday ID of the resource (job posting).
string
required
The Workday ID of the questionnaire instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_PROFILERetrieves a single job profile instance with the specified Workday ID from the Staffing service.

Input Parameters

string
required
The Workday ID of the job profile resource to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_PROFILES_VALUESRetrieves job profiles instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_REQUISITION_VALUESRetrieves job requisitions instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_WORKSPACETool to retrieve a single workspace instance for a specific job. Use when you need detailed workspace information for a job, including location and hierarchy details.

Input Parameters

string
required
The Workday ID of the job resource. This is the unique identifier for the job whose workspace information you want to retrieve.
string
required
The Workday ID of the workspace subresource. This is the unique identifier for the specific workspace instance within the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_JOB_WORKSPACESRetrieves a collection of workspaces for the specified job ID. Use this action when you need to fetch all workspace assignments associated with a specific job in the Workday staffing system. Supports pagination through limit and offset parameters.

Input Parameters

string
required
The Workday ID of the job resource. This is the unique identifier for the job whose workspaces you want to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_LEARNING_CONTENTRetrieves a single learning content item by Workday ID, returning the detail-level representation of programs, courses, course offerings, and other content types in the Learning catalog.

Input Parameters

string
required
The Workday ID of the learning content to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_LEARNING_CONTENT_LESSONRetrieves a single lesson for a learning content item.

Input Parameters

string
required
The Workday ID of the learning content.
string
required
The Workday ID of the lesson.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_LEARNING_RECORDRetrieves a single learning record with the specified ID.

Input Parameters

string
required
The Workday ID of the learning record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_LEAVE_STATUS_VALUESGet all available leave status values from Workday. Returns reference data for leave statuses such as ‘Canceled’, ‘In Progress’, ‘Successfully Completed’, ‘Process Terminated’, and ‘Rescinded’. These values can be used to filter or query leave of absence requests in other Workday endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_LOCATION_VALUESRetrieves location instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_MENTORSHIPReturns the mentorship for the given ID, viewable by the authenticated user. Use to inspect a specific mentorship’s lifecycle state, mentor / mentee, and purpose.

Input Parameters

string
required
The Workday ID of the mentorship to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_MESSAGE_TEMPLATE_BY_IDRetrieves a message template with the specific ID.

Input Parameters

string
required
The Workday ID of the message template to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_MINIMUM_WAGE_RATES_COUNTRIES_VALUESRetrieves the list of country instances that are valid as the ‘country’ filter on the GET /minimumWageRates endpoint. Use this to discover the country Workday IDs available in the tenant before calling List Minimum Wage Rates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_MINIMUM_WAGE_RATES_TAX_AUTHORITIES_VALUESRetrieves the list of payroll tax authority instances that are valid as the ‘taxAuthority’ filter on the GET /minimumWageRates endpoint. Use this to discover the tax authority Workday IDs available in the tenant before calling List Minimum Wage Rates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_MY_JOB_POSTINGSFinds job postings associated with requisitions from interviews where the authenticated user is an interviewer, fetching one page of interviews and one page of postings per requisition. By default it includes only postings with no end date; interview-request authentication or permission errors return empty results.

Input Parameters

integer
Maximum number of interviews to fetch when searching for assigned requisitions. Also limits the number of job postings retrieved per requisition. Defaults to 100.
boolean
Whether to include closed job postings in the results. If False, only returns currently open postings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_NAME_COMPONENTSRetrieves a collection of configuration information about name components for a specific country. Use this action when you need to get the allowed and required name components (e.g., first name, last name) for a country in Workday. This is useful for validating person name inputs or understanding country-specific name format requirements.

Input Parameters

string
required
The Workday ID of the country resource. This is a unique identifier for the country in Workday’s system. Example: ‘US’ for United States, ‘CA’ for Canada
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
The Workday ID of the person’s current name being updated. Required when you use Default Format and a Country using Local Script to get component data for an existing name. Failure to provide this when appropriate may result in incorrect name component data being returned.
boolean
If true, this method returns the set of allowed and required name components that uses Western Script. The default is false.
string
The Name Configuration Format for which to return values. Required. Failure to provide this will result in no name components being returned. Available values: RECRUITING_FORMAT (for Recruiting) or OTHER_FUNCTIONAL_AREAS (for all other functional areas in Workday).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_NAME_PRONUNCIATIONSRetrieves a collection of audio name pronunciations for a specific person, with optional paging and current-audio filtering. A response reporting “not found: person” is returned as an empty collection.

Input Parameters

string
required
The Workday ID of the person resource. This is a unique identifier for the person in Workday’s system. Example: ‘00000000000000000000000000000000’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
boolean
Download only the currently active audio. When set to true, only the active pronunciation audio will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_NOTIFICATION_TYPE_BY_IDRetrieves the details of a specific notification type by its Workday ID. Use after List Notification Types to inspect a particular category before referencing it from a message template.

Input Parameters

string
required
The Workday ID of the notification type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATIONRetrieves an organization instance by ID from the Workday Common API v1. Use this action when you need to fetch the basic display details for a specific organization in Workday (id, descriptor, href). The endpoint returns the organization summary representation.

Input Parameters

string
required
The Workday ID of the organization to retrieve. Example: ‘WORKDAY-ORG-001’ or ‘Supervisory_Organization_123’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_BUSINESS_UNITSRetrieves business units instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGERetrieves an organization assignment change event by ID from the Workday Staffing API, returning its ID and descriptor when available.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_BUSINESS_UNITRetrieves the business unit collection for the specified organization assignment change ID. Use when you need to inspect the business unit assignment associated with an in-progress Workday organization assignment change event. The {subResourceID} path parameter in the item endpoint must equal the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMMENTRetrieves the comment collection for the specified organization assignment change ID. Use when you need to inspect comments staged on an in-progress Workday organization assignment change. The {subResourceID} path parameter in the item endpoint must equal the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMMENT_BY_IDRetrieves the comment sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Use when you need to inspect the comment text staged on the organization assignment change.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the comment subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMPANYRetrieves the company collection for the specified organization assignment change ID. Use when you need to inspect the company assignment associated with an in-progress Workday organization assignment change event. The {subResourceID} path parameter in the item endpoint must equal the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMPANY_BY_IDRetrieves the company sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Use when you need to inspect the company assignment staged on the organization assignment change.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the company subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COST_CENTERRetrieves the cost center collection for the specified organization assignment change ID. Use when you need to inspect the cost center assignment associated with an in-progress Workday organization assignment change. The {subResourceID} path parameter in the item endpoint must equal the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_REGIONRetrieves the region collection for the specified organization assignment change ID. Use when you need to inspect the region assignment associated with an in-progress Workday organization assignment change event. The {subResourceID} path parameter in the item endpoint must equal the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_REGION_BY_IDRetrieves the region sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the region subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_START_DETAILSRetrieves the start details collection for the specified organization assignment change ID. Start details include the effective date, supervisory organization, worker, and position associated with the event. The {subResourceID} path parameter in the item endpoint must equal the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CUSTOMSRetrieves custom organizations instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_FUNDSRetrieves funds instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_REGIONSRetrieves regions instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_ASSIGNMENT_WORKERSRetrieves workers instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_GOALSRetrieves organization goal records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORGANIZATION_TYPERetrieves a specific organization type by its ID from Workday Common API. Use when you need to fetch detailed information about a single organization type, such as its name or API reference URL, for filtering or categorizing organization assignments in Workday staffing.

Input Parameters

string
required
The Workday ID of the organization type to retrieve. This is a unique identifier for the organization type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORG_ASSIGN_CHANGES_BUSINESS_UNIT_BY_IDRetrieves the business unit sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Use when you need to inspect the business unit assignment currently staged on the organization assignment change.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the businessUnit subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORG_ASSIGN_CHANGES_COST_CENTER_BY_IDRetrieves the cost center sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value. Use when you need to inspect the cost center assignment staged on the organization assignment change.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the costCenter subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORG_ASSIGN_CHANGES_CUSTOM_ORGSRetrieves the custom organizations collection for the specified organization assignment change ID. The {subResourceID} path parameter in the item endpoint must equal the {ID} value. Use when you need to inspect the custom organization assignments staged on the event.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORG_ASSIGN_CHANGES_CUSTOM_ORGS_BY_IDRetrieves the custom organizations sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the customOrganizations subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORG_ASSIGN_CHANGES_START_DETAILS_BY_IDRetrieves the start details sub-resource for the specified organization assignment change ID. The {subResourceID} path parameter must be the same as the {ID} value.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the startDetails subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_ORG_FOR_WORKERRetrieves a page of organizations associated with a specific worker from the Workday Common API v1, including organization type when returned. Use limit and offset to request additional pages.

Input Parameters

string
required
The Workday ID of the worker. Example: ‘00000000000000000000000000000000’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAY_GROUPRetrieves a single pay group instance by its Workday ID.

Input Parameters

string
required
The Workday ID of the pay group resource. This is a unique identifier for the pay group instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAY_GROUP_BY_JOB_IDRetrieves the pay group for a specified job ID. This method always returns 1 pay group.

Input Parameters

string
required
The Workday ID of the job. This is the job identifier for which to retrieve the pay group information.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
The effective date of the pay group, using the date format yyyy-mm-dd.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAY_GROUP_DETAILRetrieves a single pay group detail instance, exposing the run category, period schedule, processing-window references, and the related pay run groups that share processing.

Input Parameters

string
required
The Workday ID of the pay group detail instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAY_RATE_TYPES_VALUESRetrieves pay rate types instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAYROLL_INPUT_INSTANCERetrieves a single payroll input instance with the specified Workday ID.

Input Parameters

string
required
The Workday ID of the payroll input instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAYROLL_INTERFACE_PAY_GROUPRetrieves a single Payroll Interface pay group by Workday ID from Global Payroll v1. Use to look up pay group metadata before interacting with its periods.

Input Parameters

string
required
The Workday ID of the Payroll Interface pay group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAYROLL_INTERFACE_PAY_GROUP_PERIODRetrieves a single payroll period for the specified Payroll Interface pay group. Use to inspect the dates and status of a specific pay period.

Input Parameters

string
required
The Workday ID of the pay group.
string
required
The Workday ID of the pay period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAYROLL_JOBRetrieves a single job instance from the payroll API, including the worker, job profile, location, and supervisory organization references along with the next pay period start date.

Input Parameters

string
required
The Workday ID of the job (position) to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAYROLL_JOB_PAY_GROUPRetrieves a single pay group instance attached to a job. The job ID is the parent position; the subresource ID picks the specific pay group entry under that job.

Input Parameters

string
required
The Workday ID of the job (position) whose pay group is being retrieved.
string
required
The Workday ID of the pay group instance to retrieve under the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAY_SLIP_INSTANCES_FOR_WORKERRetrieves a specific pay slip instance for a worker from the Workday Common API v1. Use when you need to get the payment date, gross/net amounts, and status of a single pay slip for a worker.

Input Parameters

string
required
The Workday ID of the worker resource.
string
required
The Workday ID of the pay slip subresource (a specific pay slip instance for the worker).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PAY_SLIPS_FOR_WORKERRetrieves a collection of pay slips for a specific worker from the Workday Common API v1. Use when you need to access payroll history (payment date, gross / net amounts, status) for a worker.

Input Parameters

string
required
The Workday ID of the worker resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERFORMANCE_WORKER_BY_IDRetrieves a worker reference by ID through the Workday Performance Enablement REST API. The response exposes the worker’s ID, descriptor and API URL.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSONRetrieves a person in your Workday tenant. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_ADDRESSRetrieves a home address. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Address, Self-Service: Home Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_ADDRESSESRetrieves a collection of home addresses. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Address, Self-Service: Home Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
The effective date of the person’s addresses using the yyyy-mm-dd format.
boolean
If true, returns only the IDs of the person’s public addresses.
boolean
If true, returns only the IDs of the person’s primary addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_EMAILRetrieves a home email address. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Email, Self-Service: Home Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_EMAILSRetrieves a page of home email addresses for a person in Workday, with optional pagination and usage filters.

Input Parameters

string
required
The Workday ID of the person resource. Example: ‘12345’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public email addresses.
boolean
If true, returns only the IDs of the person’s primary email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_INSTANT_MESSENGERRetrieves a home instant messenger account username. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_INSTANT_MESSENGERSRetrieves a collection of home instant messenger account usernames. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public instant messenger usernames.
boolean
If true, returns only the IDs of the person’s primary instant messenger account usernames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_PHONERetrieves a home phone number. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Phone, Self-Service: Home Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_HOME_PHONESRetrieves a collection of home phone numbers. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Home Phone, Self-Service: Home Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public phone numbers.
boolean
If true, returns only the IDs of the person’s primary phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_PERSONAL_INFORMATIONRetrieves a collection of personal information for a person from Workday. Use this when you need comprehensive personal data including citizenship status, ethnicity, gender, date of birth, military service information, disability status, and other sensitive personal attributes for a specific person.

Input Parameters

string
required
The Workday ID of the person resource. Example: ‘12345’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.
string
Specifies the set of personal information by country that will be returned. If empty, the most recently updated set of personal information will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_PHOTORetrieves a personal photo. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Personal Photo, Self-Service: Personal Photo. Scope: Personal Data.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_PHOTOSRetrieves a collection of personal photos. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Personal Photo, Self-Service: Personal Photo. Scope: Personal Data.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_PREFERRED_NAMERetrieves the preferred name instance. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Preferred Name, Self-Service: Preferred Name. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_PREFERRED_NAME_BY_IDRetrieves the preferred name instance. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Preferred Name, Self-Service: Preferred Name. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_PUBLIC_CONTACT_INFORMATIONRetrieves a collection of public contact information. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_ADDRESSRetrieves a work address. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Address, Self-Service: Work Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_ADDRESSESRetrieves a collection of work addresses. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Address, Self-Service: Work Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
The effective date of the person’s addresses using the yyyy-mm-dd format.
boolean
If true, returns only the IDs of the person’s public addresses.
boolean
If true, returns only the IDs of the person’s primary addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_EMAILRetrieves a work email address. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Email, Self-Service: Work Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_EMAILSRetrieves a collection of work email addresses. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Email, Self-Service: Work Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public email addresses.
boolean
If true, returns only the IDs of the person’s primary email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_INSTANT_MESSENGERRetrieves a work instant messenger account username. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_INSTANT_MESSENGERSRetrieves a collection of work instant messenger accounts usernames. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public instant messenger usernames.
boolean
If true, returns only the IDs of the person’s primary instant messenger account usernames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_PHONERetrieves a work phone number. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Phone, Self-Service: Work Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_PHONESRetrieves a collection of work phone numbers. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Phone, Self-Service: Work Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public phone numbers.
boolean
If true, returns only the IDs of the person’s primary phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_WEB_ADDRESSRetrieves a work web address. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Web Address, Self-Service: Work Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PERSON_WORK_WEB_ADDRESSESRetrieves a collection of work web addresses. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Web Address, Self-Service: Work Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me Sentinel values: ‘ID’, ‘me’.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
boolean
If true, returns only the IDs of the person’s public web addresses.
boolean
If true, returns only the IDs of the person’s primary web addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PHONE_DEVICE_TYPESRetrieves available phone device types from Workday. Use when you need to discover valid device types for phone number collection in Workday prompts. Phone device types are used during the collection of phone numbers and include values such as ‘Mobile’, ‘Home’, ‘Work’, etc. This is a reference data endpoint.

Input Parameters

integer
The maximum number of objects in a single response. The default and maximum is 1000.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_POSITION_VALUESRetrieves positions instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROGRAMSRetrieves program (organization) instances that can be used as values for other endpoint parameters in the Workday Staffing service (Organization Assignment Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROJECT_BY_EXTERNAL_IDRetrieves a Workday project by its external identifier. Available project details may include its name, status, dates, financials, hierarchy, and worktags.

Input Parameters

string
required
The external identifier for the project. This is the ID assigned to the project that can be used to retrieve it directly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROJECT_MILESTONE_REPORT_SCHEMARetrieves project milestone report schema metadata, including field names, data types, and requirements. A 404 response containing “not available” is returned as an empty schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROJECT_TYPERetrieves a project type by ID from the Workday Spend Projects service. Available details may include its name, description, and associated projects.

Input Parameters

string
required
The unique identifier of the project type to retrieve. This is a string representation of the project type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROPOSED_POSITION_VALUESRetrieves proposed positions instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECTRetrieves a single prospect instance for talent matching and best-fit analysis.

Input Parameters

string
required
The unique Workday ID (WID) of the prospect. Must be a 32-character hexadecimal string (e.g., ‘a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_EDUCATION_BY_IDRetrieves a single education instance for the specified prospect. Resolves the education subresource by its ID under the given prospect. Scope: Recruiting, Talent Pipeline. Secured by: Prospects.

Input Parameters

string
required
The Workday ID of the resource (prospect).
string
required
The Workday ID of the specific education instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_EDUCATIONSRetrieves the educational background of a prospect from Workday Recruiting API for talent matching and best-fit analysis. This action queries the Workday Recruiting v4 API to fetch education information associated with a specific prospect. Education records include details about schools attended, degrees obtained, fields of study, and dates of attendance. Supports pagination through limit and offset parameters for prospects with multiple education entries. Requires: Workday Recruiting (ATS) API access permissions.

Input Parameters

string
required
The Workday ID (WID) of the prospect. This is a unique identifier for the prospect in Workday, typically obtained from other Recruiting API endpoints that return prospect information, such as interview or job posting candidate data.
integer
The maximum number of education objects to return in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first education object in the response collection. Use with limit for pagination. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_EXPERIENCE_BY_IDRetrieves a single work experience instance for the specified prospect. Resolves the work experience subresource by its ID under the given prospect. Scope: Recruiting, Talent Pipeline. Secured by: Prospects.

Input Parameters

string
required
The Workday ID of the resource (prospect).
string
required
The Workday ID of the specific work experience instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_EXPERIENCESRetrieves the work experience of a prospect for talent matching and best-fit analysis.

Input Parameters

string
required
The Workday ID of the prospect. This is typically obtained from other Recruiting API endpoints that return prospect information, such as interview or job posting candidate data.
integer
The maximum number of work experience objects to return in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first work experience object in the response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_LANGUAGESRetrieves the languages of the prospect with the specified ID. Returns the candidate language skills associated with this prospect. Scope: Recruiting, Talent Pipeline. Secured by: Prospects.

Input Parameters

string
required
The Workday ID of the resource (prospect).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_RESUME_ATTACHMENTSRetrieves resume attachments for a specific prospect to help prepare for upcoming interviews.

Input Parameters

string
required
The Workday ID of the prospect resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_SKILL_BY_IDRetrieves a single skill instance for the specified prospect. Resolves the skill subresource by its ID under the given prospect. Scope: Recruiting, Talent Pipeline. Secured by: Prospects.

Input Parameters

string
required
The Workday ID of the resource (prospect).
string
required
The Workday ID of the specific skill instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_PROSPECT_SKILLSRetrieves the skills of a prospect from Workday Recruiting API for talent matching and best-fit analysis. This action queries the Workday Recruiting v4 API to fetch skill information associated with a specific prospect. Skills are professional competencies, technical abilities, or expertise areas that the prospect possesses. Supports pagination through limit and offset parameters for prospects with many skills. Requires: Workday Recruiting (ATS) API access permissions.

Input Parameters

string
required
The Workday ID (WID) of the prospect. This is a unique identifier for the prospect in Workday, typically a 32-character alphanumeric string.
integer
The maximum number of skill objects to return in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first skill object in the response collection. Use with limit for pagination. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_RATING_SCALESRetrieves rating scale records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
object
Optional Workday Response_Group object. Use Workday SOAP element names as keys, for example {‘Include_Reference’: true}.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REQUESTRetrieves a single request by ID, including its completed questionnaire response. Results are secured based on the processing person’s View access to the request.

Input Parameters

string
required
The Workday ID of the request to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REQUESTED_FEEDBACK_EVENTS_ON_WORKERRetrieves a page of requested feedback events for a specified worker, including available status, expiration date, responder, template and question details.

Input Parameters

string
required
The Workday ID of the worker resource. Example: ‘00000000000000000000000000000000’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REQUEST_TYPERetrieves a single request type by ID, including the associated business object and questionnaire details. Use this to gather the information you need to create a request of this type.

Input Parameters

string
required
The Workday ID of the request type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REQUISITION_TEMPLATERetrieves the goods and service line details of a requisition template by Workday ID. Use when you want to inspect the template before constructing a new requisition from it.

Input Parameters

string
required
Workday ID of the requisition template to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REVIEW_QUESTION_CATEGORIESRetrieves review question category records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
string
Optional Review Question Category reference identifier.
string
Identifier type for review_question_category_id.
array
Optional additional Review Question Category references to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REVIEW_QUESTIONSRetrieves review question records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_REVIEW_TYPESRetrieves review type records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SCHOOL_TYPESRetrieves school type records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SKILL_SOURCE_PRECEDENCESRetrieves skill source precedence records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
string
Optional Skill Source Precedence Request reference identifier.
string
Identifier type for skill_source_precedence_request_id.
array
Optional additional Skill Source Precedence Request references to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORGANIZATIONRetrieves a single supervisory organization instance by its Workday ID. Use when you need to fetch detailed information about a particular supervisory organization including its name, code, inactive status, and the manager(s) associated with it.

Input Parameters

string
required
The Workday ID of the supervisory organization to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORGANIZATION_MEMBERRetrieves a single member instance for the specified supervisory organization ID and member subresource ID from the Staffing service.

Input Parameters

string
required
The Workday ID of the supervisory organization.
string
required
The Workday ID of the member (subresource) within the supervisory organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORGANIZATION_MEMBERSRetrieves a page of members for a specified supervisory organization, including available worker, job profile, location, and organization details. Use limit and offset to page through the collection.

Input Parameters

string
required
The Workday ID of the supervisory organization resource. This is a 32-character hexadecimal string that uniquely identifies the supervisory organization (e.g., ‘00000000000000000000000000000036’).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORGANIZATION_ORG_CHARTRetrieves the organization chart (superior and subordinate organizations) for the specified supervisory organization ID from the Staffing service.

Input Parameters

string
required
The Workday ID of the supervisory organization whose org chart will be retrieved.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORGANIZATION_ORG_CHART_INSTANCERetrieves a single organization chart instance for the specified supervisory organization ID and org-chart subresource ID from the Staffing service.

Input Parameters

string
required
The Workday ID of the supervisory organization.
string
required
The Workday ID of the org chart entry (subresource) within the supervisory organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORG_MANAGED_BY_WORKERRetrieves a supervisory organization managed by a specific worker from the Workday Common API v1. Use when you need details (name, code, manager) about a single supervisory organization that a worker manages.

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the supervisory organization subresource managed by the worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORGS_MANAGED_BY_WORKERRetrieves a collection of supervisory organizations managed by a specific worker from the Workday Common API v1. Use when you need to know which supervisory organizations a worker manages and their management scope.

Input Parameters

string
required
The Workday ID of the worker. Example: ‘00000000000000000000000000000000’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_SUPERVISORY_ORG_VALUESRetrieves supervisory organizations instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Input Parameters

integer
The maximum number of objects in a single response.
integer
The zero-based index of the first object in a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TAX_RATES_COMPANY_INSTANCES_VALUESRetrieves the list of company instances valid as the ‘companyInstance’ field on the POST /taxRates endpoint and the ‘company’ filter on the GET /taxRates endpoint. Use this to discover the company Workday IDs available in the tenant before creating or filtering company SUI rates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TAX_RATES_STATE_INSTANCES_VALUESRetrieves the list of payroll state authority instances valid as the ‘stateInstance’ field on the POST /taxRates endpoint and the ‘payrollStateAuthorityTaxCode’ filter on the GET /taxRates endpoint. Use this to discover the state authority Workday IDs available in the tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_CLOCK_EVENTRetrieve one time clock event by ID. Requires the Workday Time Tracking scope and access to the Process: Time Clock Event REST API’s security domain.

Input Parameters

string
required
Workday ID or Time_Clock_Event_ID reference ID of the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_OFF_ENTRIES_FOR_WORKERRetrieves a collection of time off entries for a specific worker from the Workday Common API v1. Use this to get time off records (date, units, type, unit-of-time) for a worker identified by their Workday ID.

Input Parameters

string
required
The Workday ID of the worker resource. Can be obtained from ‘Get Current User’ or ‘List Workers’ actions.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_OFF_ENTRY_FOR_WORKERRetrieves a specific time off entry for a worker from the Workday Common API v1. Use when you need detailed information about a particular time off record (date, units, time off type) for a worker identified by their Workday ID.

Input Parameters

string
required
The Workday ID of the worker resource. Can be obtained from ‘Get Current User’ or ‘List Workers’ actions.
string
required
The Workday ID of the time off entry subresource. Can be obtained from the ‘Get Time Off Entries for Worker’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_OFF_PLANRetrieves a particular time off plan for a specific worker from the Workday Common API v1. Use this when you need detailed information (including balance and unit of time) about a single absence / time off plan configured for a worker.

Input Parameters

string
required
The Workday ID of the worker resource.
string
required
The Workday ID of the time off plan subresource (absence plan) for the worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_OFF_PLANS_FOR_WORKERRetrieves a collection of time off plans for a specific worker. Use this to get the list of time off plans (such as vacation plans, sick leave plans, etc.) that are available to or configured for a worker.

Input Parameters

string
required
The Workday ID of the worker resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_OFF_STATUS_VALUESRetrieves available time off status values from Workday. Returns a list of status values (e.g., ‘Approved’, ‘Submitted’, ‘Sent Back’, ‘Not Submitted’) that can be used as parameters when querying or filtering time off requests in other endpoints. This is a reference data endpoint that requires no input parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_TIME_TYPESRetrieves time types instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_UPDATE_EMPLOYEE_REVIEW_RATINGSRetrieves update employee review rating records from Workday Performance Management.

Input Parameters

integer
The numbered page of data to return. Workday pages are 1-based.
integer
Number of objects to return in this page.
string
Optional effective date filter in YYYY-MM-DD format.
string
Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGERetrieves basic information about a Work Contact Change event, including the Alternate Work Location staged by the event, if there is one. Use this when you need to inspect a specific work-contact-information change business process instance.

Input Parameters

string
required
The Workday ID of the Work Contact Information Change resource (the business process event ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_ADDRESSESRetrieve a page of existing addresses staged for update by a parent work contact change business process in Workday’s person v4 API. Secured by Person Data: Work Address and Self-Service: Work Address; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Query parameter usedFor.
boolean
Query parameter publicOnly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_EMAIL_ADDRESSAn email address as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Email, Self-Service: Work Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_EMAIL_ADDRESSESRetrieve a page of existing email addresses staged for update by a parent work contact change business process in Workday’s person v4 API. Secured by Person Data: Work Email and Self-Service: Work Email; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public email addresses.
boolean
If true, returns only the IDs of the person’s primary email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_INSTANT_MESSENGERAn instant messenger as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_INSTANT_MESSENGERSRetrieve a page of existing instant messengers staged for update by a parent work contact change business process in Workday’s person v4 API. Secured by Person Data: Work Instant Messenger and Self-Service: Work Instant Messenger; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public instant messenger account usernames.
boolean
If true, returns only the IDs of the person’s primary instant messenger account usernames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_PHONE_NUMBERA phone number as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Phone, Self-Service: Work Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_PHONE_NUMBERSRetrieves a page of phone numbers staged for update by a work contact information change business process, with optional filters. Uses the Workday person v4 API; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public phone numbers.
boolean
If true, returns only the IDs of the person’s primary phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_WEB_ADDRESSA web address as it exists staged for update by the parent business process. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Work Web Address, Self-Service: Work Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_CHANGE_WEB_ADDRESSESRetrieves a page of web addresses staged for update by a work contact information change business process, with optional filters. Uses the Workday person v4 API; scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Specifies usage behavior, such as mailing, billing, or shipping. Optional.
string
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
boolean
If true, returns only the IDs of the person’s public web addresses.
boolean
If true, returns only the IDs of the person’s primary web addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_INFORMATION_CHANGERetrieves an existing Work Contact Change event for the worker’s Person. This is the staffing-v7, worker-scoped variant of the endpoint — distinct from the person-v4 endpoint exposed via the existing GetWorkContactChange action. Secured by: Change Work Contact Information (REST Service) Scope: Contact Information

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the Work Contact Change event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_CONTACT_INFORMATION_CHANGES_ADDRESS_AS_STAGEDRetrieves an address as it exists staged for update by the parent business process. Use when you need to retrieve the current state of an address that has been staged for modification within a work contact information changes business process. This action is read-only and retrieves the staged address details. To modify the staged address, use the update action instead.

Input Parameters

string
required
The Workday ID of the work contact information change resource.
string
required
The Workday ID of the address subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKERRetrieves current staffing information for a specified non-terminated worker by Workday ID through the Staffing service, including available job and organizational details.

Input Parameters

string
required
The Workday ID of the worker to retrieve. Example: ‘00000000000000000000000000000000’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER2Retrieves a single worker’s current staffing information via the Time Tracking service. Use the literal ‘me’ for the path ID to retrieve the current processing worker.

Input Parameters

string
required
The Workday ID of the worker to retrieve. Accepts a real WID or the literal ‘me’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_ANYTIME_FEEDBACK_EVENT_BY_IDRetrieves a specified worker’s feedback given event through the Performance Enablement REST API, returning its ID, descriptor and link when available.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_BUSINESS_TITLE_CHANGESRetrieves the collection of business title changes for a specific worker from the Workday Common API v1. Use when you need to track the history of business title changes (current vs proposed titles, effective dates, initiators) for a worker.

Input Parameters

string
required
The Workday ID of the worker. Can be obtained from ‘Get Current User’ or ‘List Workers’ actions.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_CHECK_INRetrieves a single Check-In with the specified ID for the specified worker. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the Check-In instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_CHECK_INSRetrieves a page of Check-Ins for the specified worker. Supports pagination via limit and offset; secured by Self-Service: Check-Ins and Worker Data: Check-Ins, with Performance Enablement scope.

Input Parameters

string
required
The Workday ID of the worker whose Check-Ins to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in the response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_CHECK_IN_TOPICRetrieves a single Check-In topic with the specified ID for the specified worker. Secured by: Self-Service: Check-Ins, Worker Data: Check-Ins Scope: Performance Enablement

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the Check-In topic instance to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_CHECK_IN_TOPICSRetrieves a page of Check-In topics for the specified worker, with pagination via limit and offset. Secured by Self-Service: Check-Ins and Worker Data: Check-Ins; scope: Performance Enablement.

Input Parameters

string
required
The Workday ID of the worker whose Check-In topics to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in the response collection. The default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_DEVELOPMENT_ITEM_BY_IDRetrieves a development item reference for the specified worker via the Performance Enablement REST API. The response exposes only the item’s ID, descriptor, and href.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_ELIGIBLE_ABSENCE_TYPESRetrieves a collection of eligible absence types for the specified worker. This returns the types of absences (leaves, time off, etc.) that a worker is eligible to request. Each absence type includes details like the category (Leave of Absence, Time Off, etc.), unit of time (Days, Hours), and various configuration flags. Note: Due to Workday security permissions, this typically only works for the authenticated user’s own worker ID.

Input Parameters

string
required
The Workday ID of the worker resource. Note: Due to Workday security permissions, this endpoint typically only allows access to the authenticated user’s own data. Use the current user’s worker ID from the Get Current User action.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
The Workday ID of the absence type category. Valid values: Leave of Absence Type (00000000000000000000000000000102), Absence Table (00000000000000000000000000000103), Time Off (00000000000000000000000000000005).
string
The effective date for which eligible absence types need to be returned for the worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_EXPLICIT_SKILLRetrieves a single explicit-skill usage for the specified worker. Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the explicit-skill usage to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_EXPLICIT_SKILLSRetrieves explicit skills associated with a Skill Enabled worker. Supports filtering by skill name (skill) and by skill source (skillSource), plus pagination via limit and offset. Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills

Input Parameters

string
required
The Workday ID of the worker whose explicit skills to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
string
Retrieves the skills for the specified skill name.
integer
The zero-based index of the first object in the response collection. The default is 0.
string
The Workday ID of the skill source. Returns skills associated with the skill source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_EXTERNAL_SKILL_LEVELSRetrieves all external skill level information for a worker. Supports filtering by externalSkillId and pagination via limit/offset. Secured by: Self-Service: External Skill Source, Worker Data: External Skill Source Scope: Worker Profile and Skills

Input Parameters

string
required
The Workday ID of the worker.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in the response collection. The default is 0.
string
If passed, the external skill level associated with the External Skill ID is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_FOR_SUPERVISORY_ORGRetrieves a worker instance for a specific supervisory organization from the Workday Common API v1. Use when you need a worker’s summary (business title, email, phone, manager flag) scoped to a supervisory organization.

Input Parameters

string
required
The Workday ID of the supervisory organization.
string
required
The Workday ID of the worker subresource within the supervisory organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_GOAL_BY_IDRetrieves a single goal instance for a specific worker. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_HISTORY_ITEMRetrieves a specific history item (business process) for a worker from the Workday Common API v1. Use when you need detailed information about a particular employment change or business process for a worker, including initiator, initiation timestamp, and effective/due dates.

Input Parameters

string
required
The Workday ID of the worker. Can be obtained from actions like ‘Get Current User’ or ‘List Workers’.
string
required
The Workday ID of the history item subresource. Can be obtained from the ‘Get History Items for Worker’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_LEAVE_OF_ABSENCERetrieves the leave-of-absence record for a worker by its subresource ID. Use Get Worker Leaves Of Absence first to find available subresource IDs. Returns the full leave detail including status, reason, dates, and impact fields.

Input Parameters

string
required
The Workday ID of the worker, or the literal ‘me’ to refer to the authenticated user.
string
required
The Workday ID of the leave-of-absence event. Obtain from Get Worker Leaves Of Absence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_LEAVES_OF_ABSENCERetrieves the Leaves Of Absence for the specified worker using the working absenceManagement v1 API.

Input Parameters

string
required
The Workday ID of the worker resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
array
The Workday ID (UUID) of the status of the Leave Of Absence. Use the Get Leave Status Values action to retrieve valid status IDs. Common statuses include: Successfully Completed, In Progress, Canceled, Rescinded, and Process Terminated. You can specify multiple status IDs to filter by multiple statuses.
string
The end of a date range filter using the yyyy-mm-dd format.
string
The start of a date range filter using the yyyy-mm-dd format.
array
The Workday ID (UUID) of the type of Leave Of Absence to filter by. You can specify multiple leave type IDs to filter by multiple types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_MANAGERResolve a Workday worker’s manager through the worker’s primary supervisory organization. Requires a visible primary supervisory organization and its single-assignment manager.

Input Parameters

string
required
Worker WID, Employee_ID= value, or Contingent_Worker_ID= value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_ORGANIZATIONRetrieves a specific organization instance for a worker from the Workday Common API v1. Use when you need details about a single organization association (and its organization type) for a worker.

Input Parameters

string
required
The Workday ID of the worker resource.
string
required
The Workday ID of the organization subresource (worker organization assignment).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_REPORTSRetrieves a collection of direct reports for a specific worker from the Workday Common API v1. Use when you need to find all workers who report directly to a given manager. Supports pagination via the limit and offset parameters.

Input Parameters

string
required
The Workday ID of the worker resource. Example: ‘00000000000000000000000000000000’
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_REQUESTED_FEEDBACK_ON_SELF_EVENT_BY_IDRetrieves a single self-requested feedback event instance for the specified worker. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_REQUESTED_FEEDBACK_ON_WORKER_EVENT_BY_IDRetrieves a single requested feedback event instance for the specified worker. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKERS_COMPENSATION_CODE_OVERRIDESRetrieves workers’ compensation code override instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_SERVICE_DATERetrieves a single service date information instance for a specified worker from Workday Staffing API. Use when you need to get hire date and continuous service date information for a specific service date record. This action retrieves a single service date instance using the worker ID and service date subresource ID.

Input Parameters

string
required
The Workday ID of the worker resource. Can be obtained from ‘List Workers’ or ‘Get Current User’ actions.
string
required
The Workday ID of the service date subresource. Can be obtained from the ‘Get Worker Service Dates’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKERS_IN_SUPERVISORY_ORGRetrieves a collection of workers for a specific supervisory organization from the Workday Common API v1. Use when you need to list all workers (employees and contingent workers) belonging to a particular supervisory org. Supports pagination via the limit and offset parameters.

Input Parameters

string
required
The Workday ID of the supervisory organization. Use the Get Supervisory Organization Values action to find valid IDs.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_SKILL_ITEMRetrieves a single skill item for the specified worker. The collection variant is exposed by GetWorkerSkillItems. Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills

Input Parameters

string
required
The Workday ID of the worker.
string
required
The Workday ID of the skill item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_SKILL_ITEMSRetrieves a collection of skill items for a specific worker from Workday Staffing API. Use when you need to access a worker’s professional skills, competencies, or expertise areas for talent management, team composition analysis, or skills inventory purposes. Requires: Person Data: Skills or Self-Service: Skills permissions.

Input Parameters

string
required
The Workday ID of the worker resource. This is a unique identifier for the worker, typically a 32-character alphanumeric string.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_STOCK_PLAN_ASSIGNMENTSRetrieve current stock-plan assignment data for exactly one referenced worker using Workday Human Resources Get_Workers v46.0. Returns only Stock_Plan_Data, not the generic worker profile. It does not provide grants, vesting events, exercise transactions, assignment history, or visibility diagnostics.

Input Parameters

string
required
Worker identifier to place in the mandatory Worker_Reference.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Official Workday WorkerObject identifier type for worker_id.
string
Effective date for the worker’s current compensation data.
string
Entry moment for the worker’s current compensation data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_TIME_OFF_DETAILRetrieves a specific time off detail entry for a worker. Use when you need detailed information about a particular time off record for a worker identified by their Workday ID. This action retrieves individual time off detail records including dates, duration, type, status, and related metadata. Use Get Time Off Entries for Worker to find available detail IDs first.

Input Parameters

string
required
The Workday ID of the worker resource. Can be obtained from ‘Get Current User’ or ‘List Workers’ actions.
string
required
The Workday ID of the time off detail subresource. Can be obtained from the ‘Get Worker Time Off Details’ action which returns time off detail entries with their IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_TIME_OFF_DETAILSRetrieves a collection of time off details for the specified worker.

Input Parameters

string
required
The Workday ID of the worker resource.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
array
List of Workday status IDs to filter by (e.g., [‘00000000000000000000000000000100’] for Approved status). Use the Get Time Off Status Values action to retrieve valid status IDs.
string
The end of a date range filter using the yyyy-mm-dd format.
string
The start of a date range filter using the yyyy-mm-dd format.
array
List of Workday time off type IDs to filter by (e.g., [‘00000000000000000000000000000112’] for Vacation). Use the Get Worker Eligible Absence Types action to retrieve valid type IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_TYPESRetrieves worker types instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKER_VALID_TIME_OFF_DATESRetrieves valid time off dates for a worker, indicating when they are eligible to take time off. This action checks time off eligibility based on the worker’s time off plans, position, and organizational rules. Use this to validate dates before creating time off requests or to display available time off dates to workers.

Input Parameters

string
required
The Workday ID of the worker resource.
string
The specific date to validate for time off eligibility, in yyyy-mm-dd format (e.g., ‘2026-03-15’). Use this to check if a worker can take time off on a particular date.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
The Workday ID of a specific Time Off plan/type. Use this to validate dates against a particular time off plan (e.g., vacation, sick leave).
string
The Workday ID of a specific Position to validate time off dates for. Use this when checking eligibility for a particular position/role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_SHIFTSRetrieves work shift instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORKSPACE_INSTANCESRetrieves work spaces instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WORK_STUDY_AWARDSRetrieves work study awards instances that can be used as values for other endpoint parameters in the Workday Staffing service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WQL_DATA_SOURCERetrieves a single WQL data source by ID, including its primary business object, required and optional parameters, and available data source filters. Use this when building a WQL query and you need full details about a specific data source.

Input Parameters

string
required
The Workday ID of the WQL data source to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WQL_DATA_SOURCE_FIELDRetrieves a single WQL data source field by ID, including the related business object and any required or optional WQL parameters. Use this when you need full field metadata to use that field in a WQL query.

Input Parameters

string
required
The Workday ID of the data source.
string
required
The Workday ID of the field subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GET_WQL_DATA_SOURCE_FILTERRetrieves a specific WQL data source filter by its ID. Use this when you need full details about a filter — including its required and optional parameters — to apply it correctly in a WQL query.

Input Parameters

string
required
The Workday ID of the data source.
string
required
The Workday ID of the data source filter subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_GIVE_FEEDBACKAdds a new anytime feedback event for one or more workers in Workday Talent.

Input Parameters

string
required
Rich text feedback comment to submit.
boolean
Whether the feedback is private. Workday does not allow this to be true when confidential is true or when feedback has multiple recipients.
string
Optional Workday feedback badge identifier.
boolean
Whether the feedback giver’s name should be displayed. Defaults to true because many Workday tenants disable anonymous anytime feedback.
boolean
Whether the feedback is confidential. Workday does not allow this to be true when private is true or when feedback has multiple recipients.
string
Workday identifier type for badge_id.
array
required
Identifiers for one or more workers receiving the feedback.
string
required
Identifier for the worker giving the feedback.
string
Workday identifier type for each to_worker_ids value, for example WID or Employee_ID.
string
Optional dateTime when feedback was given. Workday rejects future values. Example: 2026-07-08T09:30:00.
string
Workday identifier type for from_worker_id, for example WID or Employee_ID.
object
Optional Workday Business_Process_Parameters object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_IMPORT_EMPLOYEE_REVIEWSBulk-imports employee reviews into Workday Performance Management for asynchronous processing, rejecting review objects with an Employee_Review_Data wrapper. An accepted import is not confirmation of final success.

Input Parameters

array
required
List of employee reviews to import. Each item must contain the child fields of a Workday Employee_Review_Data element directly; do not include an outer Employee_Review_Data key because Composio adds that wrapper. Each item must include Worker_Reference and Employee_Review_Template_Reference. Other supported fields include Employee_Review_ID, Review_Completed, Manager_Reference, Review_Initiation_Date, Review_Period_Start_Date, Review_Period_End_Date, and the review section data elements. Include Manager_Reference when Review_Completed is true. Use a unique Employee_Review_ID for each new review. Include both review period dates when the selected template does not define them; omit them when the template defines the period. Use Workday SOAP element names as keys, nested dicts/lists for child elements, @name keys for XML attributes, and #text for element text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_INITIATE_HOME_CONTACT_INFORMATION_CHANGEInitiate a worker’s Home Contact Change event through Workday Staffing v7. The returned event ID is required by the Person v4 staging and submit tools. Initiation does not mean configured approvals or later business-process steps are complete. Requires the Contact Information scope and permission to initiate Change Home Contact Information (REST Service) for the worker.

Input Parameters

string
required
Workday worker ID for whom to initiate the Home Contact Change event.
string
Optional display-name override for the Home Contact Change event.
string
required
Date on which the home-contact changes take effect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_INITIATE_WORK_CONTACT_INFORMATION_CHANGECreates a new Work Contact Change business process event for the parent Person of the specified worker. The returned event ID can be used to manage the change via the related person-v4 / staffing-v7 sub-resource endpoints. Secured by: Change Work Contact Information (REST Service) Scope: Contact Information

Input Parameters

string
required
The Workday ID of the worker.
string
Optional display-name override for the change instance.
string
The date this business process takes effect (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_INITIATE_WORKER_ORGANIZATION_ASSIGNMENT_CHANGEInitiates an organization assignment change for a specific worker, returning a new change ID that can be used in subsequent update or submit operations. This is the worker-scoped POST endpoint; the top-level /organizationAssignmentChanges POST is exposed by CreateOrganizationAssignmentChange. Both are exposed in the Workday spec. Secured by: Change Organization Assignments Scope: Organizations and Roles

Input Parameters

string
required
The Workday ID of the worker.
string
required
The date this business process takes effect (YYYY-MM-DD). Required by Workday.
object
Position reference for the assignment change.
string
Optional display-name override for the change instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ABSENCE_BALANCESRetrieves absence balances for time off plans and leave of absence types. Can be filtered by worker ID, category, and effective date.

Input Parameters

integer
Maximum number of balance records to return per page (1-100). Default is 20.
integer
Zero-based index for pagination. Use with limit to page through results. Default is 0.
string
The Workday ID of the worker to retrieve balances for. If not specified, returns balances for all workers.
string
Filter by Workday ID of a specific Time Off Plan, Leave Type, or Absence Table category.
string
Retrieve absence balances as of a specific date in yyyy-mm-dd format (e.g., ‘2024-12-31’). If not specified, uses current date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ABSENCE_MANAGEMENT_WORKERSRetrieves a collection of workers and current staffing information from absenceManagement. Use to find a worker Workday ID before calling absence-specific endpoints (eligible absence types, balances, leaves of absence, time off entries). Supports searching by name or worker ID and filtering by organization visibility.

Input Parameters

integer
The maximum number of objects in a single response. Default 20, maximum 100.
integer
The zero-based index of the first object in a response collection. Default 0.
Searches workers by name or worker ID. The search is case-insensitive. Space-delimited tokens can be used to widen the match.
boolean
Only return workers whose supervisory organizations are visible to the processing user. Requires the ‘Enable Restrict Workers and Org Search Result by User-based Security’ setting in the Workday tenant.
boolean
Include terminated workers in the output. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ACTIVE_MARITAL_STATUSESMarital Statuses that are Active and configured for the Country or Country Region. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ACTIVE_TASKSReturns the active tasks running in the Workday system, with pagination support. Use for monitoring task throughput, queue depth, and CPU/memory consumption.

Input Parameters

integer
The maximum number of objects in a single response. Default 20, max 100.
integer
Zero-based index of the first object in the response collection. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ACTIVE_USER_SESSIONSRetrieves the collection of active user sessions in the Workday tenant with pagination support. Use for auditing concurrent logins, identifying long-running sessions, or investigating sign-on patterns.

Input Parameters

integer
The maximum number of objects in a single response. Default 20, max 100.
integer
Zero-based index of the first object in the response. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ACTIVITY_LOGGINGRetrieves a collection of user activity log entries in a specified time frame. The ‘from’ and ‘to’ parameters are required by Workday. Optional filters: user (systemAccount), task (taskId), pagination, and total-count-only mode (returnUserActivityEntryCount).

Input Parameters

string
(Required) Date and time of the latest log entry. Format: “{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}.{sss}Z” (default UTC).
string
(Required) Date and time of the earliest log entry. Format: “{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}.{sss}Z” (default UTC).
integer
Maximum number of objects in a single response (default 20, max 100). For activity logging the recommended max is 1000.
integer
Zero-based index of the first object in the response collection.
string
Filter by task ID.
string
Filter by system account.
number
Multiplier (x 10,000) for total requested user activity instances. Example: 5 = 50,000.
boolean
If true, return only the total count of activity instances for the specified parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ALLOWED_PERSONAL_INFORMATION_COUNTRIESThe set of countries a person is allowed to populated with country specific data. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Personal Information, Self-Service: Personal Information. Scope: Personal Data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ATTENDANCE_STATUS_VALUESRetrieves attendance status instances usable as values for the attendanceStatus field on lesson tracking and enrollment endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BALANCESRetrieves the balance of all absence plan and leave of absence type for the specified worker ID.

Input Parameters

integer
The maximum number of balance records to return in a single response. Default is 20, maximum is 100.
integer
The zero-based index of the first record to return. Default is 0. Use with limit for pagination.
string
The Workday ID of the worker whose balances should be returned. If not specified, returns balances for all accessible workers.
string
The Workday ID of the Time Off, Leave Type, or Absence Table to filter by. This is a 32-character hexadecimal ID (e.g., ‘00000000000000000000000000000105’). If not specified, returns balances for all categories.
string
Return absence balances as of the specified date in yyyy-mm-dd format (e.g., ‘2025-12-31’). If not specified, returns current balances.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BUSINESS_PROCESS_EVENT_COMMENTSRetrieves a collection of comment references for the specified business process event, including available IDs, descriptors, and resource URLs. Supports pagination.

Input Parameters

string
required
The Workday ID of the business process event whose comments are to be retrieved.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BUSINESS_PROCESS_EVENT_REMAINING_STEPSRetrieves a page of remaining (not-yet-completed) steps for a specified business process event. Use it to see the steps still pending on an in-progress business process.

Input Parameters

string
required
The Workday ID of the business process event whose remaining steps are to be retrieved.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BUSINESS_PROCESS_EVENTSRetrieves a collection of business process events filtered by worker, initiator, type, status, and initiation/completion date ranges. Use this when you need to enumerate the business processes (job changes, time-off requests, hires, etc.) that belong to a worker. At least one worker filter must be set or the spec returns an empty response.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.
array
Filter by one or more event status Workday IDs (e.g., InProgress, Completed). Repeat the query parameter for each value.
string
Workday ID of the worker whose business process events to return. Pass ‘me’ to use the current user. The spec requires at least one worker filter to be set.
array
Filter by one or more initiator (worker) Workday IDs. Repeat the query parameter for each value.
array
Filter by one or more business process type Workday IDs. Repeat the query parameter for each value.
string
Return events completed on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
string
Return events initiated on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
string
Return events completed on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).
string
Return events initiated on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BUSINESS_PROCESS_EVENT_STEPSRetrieves a collection of business process event steps, filterable by business process type, creation date, due date, and step type. Use this for cross-event workload queries — e.g., “what approvals are due this week” or “what steps were created today across all business processes”.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.
array
Filter by one or more step type Workday IDs (e.g., Approval, ToDo, Questionnaire). Repeat the query parameter for each value.
array
Filter by one or more business process type Workday IDs. Repeat the query parameter for each value.
string
Return event steps created on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
string
Return event steps due on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
string
Return event steps created on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).
string
Return event steps due on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BUSINESS_PROCESS_TYPE_ATTACHMENT_CATEGORIESRetrieves a page of attachment categories selectable for a specified business process type, optionally filtered by event target. The returned category IDs can be used for business process event attachments.

Input Parameters

string
required
The Workday ID of the business process type whose attachment categories are to be retrieved.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.
string
Workday ID of the event target that this business process is about. Pass an ID returned by an API for the event target type (e.g., a worker ID when the business process targets a worker) to filter the categories list to those valid for that target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_BUSINESS_PROCESS_TYPESRetrieves a collection of business process types defined in the tenant. Use this to enumerate the catalog of business process definitions (Hire, Change Job, Time Off, Termination, etc.) that the tenant supports. The IDs returned can be passed to event-listing filters.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CASCADE_GOAL_TALENT_POOLSTalent Pools the processing user has view and edit access for. Secured by: Talent Pool: View and Edit Scope: Talent Pipeline. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CASE_TYPESReturn one bounded page of Workday Help case types available to a specific worker. Use the worker filter before creating a case on behalf of that worker, and advance offset to retrieve another page.

Input Parameters

integer
Maximum case types to return, from 1 through 100.
integer
Zero-based result offset.
string
Worker ID used to determine case-type access. Omit to use the processing worker; set this to the same worker used as forWorker when creating on behalf.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COMPENSATION_PLANSRetrieve detailed compensation plans with the official Workday Compensation v46.0 Get_Compensation_Plans SOAP operation.

Input Parameters

integer
One-based page number. Pages after page 1 require as_of_entry_datetime.
integer
Number of compensation plans to return per page, from 1 through 999.
boolean
Whether to include inactive compensation plans and guideline components.
string
Effective date for application data. Workday defaults to today.
string
Entry timestamp for the result set. Reuse it across pages to keep paginated results stable.
array
Optional official compensation plan type criteria or Workday WIDs.
array
Specific compensation plans to retrieve. Do not combine with plan type criteria or include_inactive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COMPENSATION_WORKERSLists workers from the Workday Compensation v3 API with pagination and case-insensitive name search. Use this when you need to look up worker IDs to feed into other compensation actions (Get Employee Compensation, Request One-Time Payment, etc.) and want the results scoped to the compensation service’s view of workers. Note: Compensation v3 and Staffing v7 both expose /workers — they are secured under the same Staffing scope but live on separate sub-API paths; this action targets the compensation surface.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
Case-insensitive substring search across worker names. Use to narrow the list when you know part of the worker’s display name.
boolean
Include terminated workers in the output. Defaults to false in Workday when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COUNTRIESRetrieves country instance references that can be used as values for other recruiting endpoint parameters. Prompt Values endpoint under the recruiting service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COUNTRY_COMPONENTS_COUNTRYRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COUNTRY_COMPONENTS_COUNTRY_CITYRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COUNTRY_COMPONENTS_COUNTRY_REGIONRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_COUNTRY_PHONE_CODESExposes prompting for country phone codes, which are used during the collection of phone numbers. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: REST API Public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CURRENCIESRetrieves the details on all currencies in your tenant from Core Accounting (id, descriptor, code, precision). Use to populate currency pickers or to map currency codes to Workday WIDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_FIELD_TYPE_LIST_VALUESRetrieves a page of selectable values configured for a custom list field type used by a custom object definition. Supports pagination to enumerate the options.

Input Parameters

string
required
The Workday ID of the custom field type (custom list) whose list values to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_FIELD_TYPESRetrieves a page of custom field types configured in Workday’s custom object subsystem, optionally filtered by native field type. Supports pagination to discover the field-type catalog.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.
array
Workday IDs of native field types to filter on. Repeatable: pass a list to request multiple types, which Workday emits as ?fieldType=A&fieldType=B on the wire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_OBJECT_DEFINITION_CONDITION_RULESRetrieves a page of condition rules attached to a custom object definition. Use limit and offset to enumerate rules across pages.

Input Parameters

string
required
The Workday ID of the custom object definition whose condition rules to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_OBJECT_DEFINITION_FIELDSRetrieves a page of field summaries for a custom object definition. Each summary can include the field ID, descriptor, and resource URL; use limit and offset to page through the collection.

Input Parameters

string
required
The Workday ID of the custom object definition whose fields to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_OBJECT_DEFINITIONSRetrieves a page of custom object definitions, including multi-instance and single-instance objects. Use it to discover available custom objects and inspect high-level metadata such as name, alias, active flag, and extended business object.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_OBJECT_DEFINITION_VALIDATIONSRetrieves a page of validations defined on a custom object definition. Use limit and offset to enumerate the checks before editing or auditing them.

Input Parameters

string
required
The Workday ID of the custom object definition whose validations to retrieve.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_CUSTOM_OBJECTS_MULTI_INSTANCERetrieves IDs of multi-instance custom objects of a specified alias attached to a Workday business object instance. Security depends on the security domain configured for the custom object.

Input Parameters

string
required
The Workday ID of the extended business object instance.
string
required
The web service alias of the custom object. Determine this by running the ‘View Custom Object’ task in Workday.
string
required
Resource name of the Workday business object that has been extended by the multi-instance custom object. Examples: workers, customers, suppliers, projects, customWorktag01.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_DURATION_UNIT_VALUESRetrieves duration unit instances usable as values for the duration field on lesson tracking and enrollment endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_EMPLOYEE_ENROLLMENT_EVENTSRetrieves the latest benefit enrollment events of the processing worker, optionally filtered to a specific enrollment offering type or plan type. Use to display the worker’s current/in-progress benefit elections.

Input Parameters

string
Benefit Election or Plan Type (e.g., “Healthcare”, “Retirement Savings”).
boolean
If true, return only the current active enrollment offerings of the processing worker.
string
WID of Enrollment Offering Type (e.g., Medical, Dental, Vision, 401(k), Basic Group Life).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_EXPENSE_ENTRIESRetrieves a paginated collection of Quick Expense entries from Workday Expense v1. Supports filtering by entry type, status, and a date range. Use this when discovering Quick Expenses associated with a tenant or worker before adding them to an expense report or updating/deleting individual entries.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. Use offset with limit to page through results.
string
Latest entry date to include in results (YYYY-MM-DD).
string
Earliest entry date to include in results (YYYY-MM-DD).
string
Filter entries by their class type (Workday ID of the entry type, e.g. ‘Quick Expense’, ‘Credit Card Transaction’).
string
Filter entries by status (Workday ID of the expense entry status instance).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_EXPENSE_ITEMSRetrieves a paginated collection of expense items (spend categories) from Workday Expense v1. Supports filtering by a search string and optionally excluding fixed-amount items. Use this when an LLM needs to pick a valid expense item ID before creating a Quick Expense or expense report line.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. Use offset with limit to page through results.
string
Case-insensitive substring filter applied to the expense item name.
boolean
If true, exclude fixed-amount expense items (e.g. per-diem items) from the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_EXPENSE_REPORTSRetrieves a collection of expense reports from Workday Expense v1. Reports can be filtered by memo, status, and a creation date range. Use this when you need to list, search, or filter expense reports for approval workflows, financial reporting, or audit purposes.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with limit to page through a response collection.
string
Filter expense reports created on or before this date (YYYY-MM-DD).
string
Filter expense reports created on or after this date (YYYY-MM-DD).
string
Filter expense reports by memo (substring match).
array
Filter expense reports by one or more status WIDs. Repeat the query parameter to filter on multiple statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_FEDERAL_W4_ELECTIONSList federal W-4 tax election data from Workday Payroll v46.0 by election references or by worker references with optional company and effective-date criteria. Returns one Workday response page.

Input Parameters

integer
One-based Workday response page number.
integer
Number of elections to return, from 1 through 999.
array
One or more federal W-4 tax election references. Use this selector or worker_references, but not both.
string
Optional effective date criterion. If supplied, Workday returns the election in effect on this date.
object
Optional company criterion used with worker_references. If omitted, elections for every company associated with each worker are returned.
boolean
Whether Workday should include election references in the response.
array
One or more workers whose federal W-4 elections should be returned. Use this selector or w4_references, but not both.
string
Optional Workday response effective-moment date.
string
Optional Workday response entry moment. Supply this when paging to keep the result set stable between requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_FEEDBACK_BADGESRetrieves a collection of active Feedback Badges. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_FEEDBACK_ON_WORKER_VALUESRetrieves instances that can be used as values for other endpoint parameters in this service. Secured by: Worker Data: Role Requested Feedback, Worker Data: Self Requested Feedback Scope: Performance Enablement, Worker Profile and Skills. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_FEEDBACK_RESPONDER_VALUESRetrieves instances that can be used as values for other endpoint parameters in this service. Secured by: Self-Service: Role Requested Feedback, Self-Service: Self Requested Feedback, Worker Data: Role Requested Feedback, Worker Data: Self Requested Feedback Scope: Performance Enablement, Worker Profile and Skills. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_FEEDBACK_TEMPLATE_VALUESRetrieves instances that can be used as values for other endpoint parameters in this service. Secured by: Self-Service: Role Requested Feedback, Self-Service: Self Requested Feedback, Worker Data: Role Requested Feedback, Worker Data: Self Requested Feedback Scope: Performance Enablement, Worker Profile and Skills. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_GIVE_REQUESTED_FEEDBACK_EVENTSRetrieves a page of requested feedback events through the Workday Performance Enablement API. Each returned item exposes its ID, descriptor, and link.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_GRADE_VALUESRetrieves grade instances usable as values for the grade field on lesson tracking and enrollment endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_GRAPH_API_VERSIONSRetrieves all supported Workday Graph API versions. Use this action when you need to discover which Graph API versions a Workday tenant supports before issuing Graph API calls.

Input Parameters

boolean
For Internal Use Only. Whether to include test versions in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_HELP_CASE_CONFIGURATIONSRetrieves tenant setup configurations related to Help Case Management. Configuration details include confidential case message, file configurations, and maximum number of attachments.

Input Parameters

integer
Maximum number of objects to return. Default 20, max 100.
integer
Zero-based index of the first object in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_HOME_CONTACT_CHANGE_ADDRESSESReturn one bounded page of addresses staged in one Workday Home Contact Change event. Use the event ID from initiation; each returned address ID can be passed to the replace tool. Advance offset to retrieve another page. Requires the Contact Information scope and access to Person Data: Home Address or Self-Service: Home Address for the event’s worker.

Input Parameters

integer
Maximum number of staged addresses to return (1-100).
integer
Zero-based index of the first staged address to return.
string
required
Home Contact Change event ID returned by the initiate tool.
string
Optional Workday usage value by which to filter staged addresses.
boolean
When set, return only primary addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_INTERVIEWSRetrieves a list of interviews with job requisition and recruiter assignment details. Supports filtering by status for pipeline review and scheduled interviews.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
array
All applicable interview statuses for an Interview event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_JOB_CHANGE_REASONSRetrieves the collection of job change reasons from the Workday Common API v1. Use when you need available job change reason reference data (with flags for employee / contingent worker / manager use) for job changes, business title changes, and other staffing operations.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. Use offset with the limit parameter to control paging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_JOB_FAMILIESRetrieves a collection of job families from the Workday Staffing service. Supports filtering by job family group, job profile, and active/inactive state, with pagination via limit/offset.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.
boolean
If true, the method returns inactive job families. Default is false.
array
The job profile for the job family. You can specify more than 1 jobProfile query parameter. For possible values, you can use a returned id from GET /jobProfiles.
array
The job family group for the job family. You can specify more than 1 jobFamilyGroup query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_JOB_POSTING_FILTER_VALUESReturn one bounded page of active external job postings that have started, using Recruiting SOAP v46.2 Get_Job_Postings. This intentionally matches the set exposed by REST LIST_JOB_POSTINGS in live testing; expired, internal, or future postings are not discovery candidates. Pass a returned posting_wid as the preferred raw value in LIST_JOB_POSTINGS.jobPosting. Alternatively, format the returned job_posting_id as Job_Posting_ID=<job_posting_id>. Do not pass the REST result id or an unprefixed human Job_Posting_ID. For pagination, reuse response_results.as_of_entry_datetime and response_results.count.

Input Parameters

integer
One-based Workday page to return.
integer
Maximum filter values to return on this page, from 1 through 100.
string
Stable entry timestamp. On page 1, omit this to use the current time; the action returns Workday’s applied value in response_results. Required after page 1 and reused across pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_JOB_POSTINGSRetrieves a paginated list of job postings from Workday Recruiting system. This action queries the Workday Recruiting API to fetch job postings with optional filtering by job requisition, category, posting WIDs, or job sites. Supports pagination through limit and offset parameters. Returns structured job posting data including titles, departments, locations, status, and dates. Requires the Recruiting (ATS) API scope to be enabled for the integration user.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
array
Filter job postings by job site IDs. Allows filtering by the sites/locations where jobs are posted.
array
Filter job postings by category IDs. Allows filtering by one or more job categories/classifications.
array
Filter by values from LIST_JOB_POSTING_FILTER_VALUES. Prefer its raw posting_wid, or format its human job_posting_id exactly as Job_Posting_ID=<job_posting_id>. Do not use the REST id returned by this action or an unprefixed human Job_Posting_ID. Discovery covers active external postings that have started; live testing found that set matched this REST collection’s total.
array
Job Requisition for Job Posting Anchor

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_JOB_PROFILESRetrieves a collection of job profiles from the Workday Staffing service. Supports filtering by active/inactive state and pagination via limit/offset.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0.
boolean
If true, the method returns inactive job profiles. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_JOBSRetrieves a collection of jobs from Workday Staffing system. Use this to get current staffing information including job positions, workers, and organizational details.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_LEARNING_CONTENTRetrieves a collection of learning content items including programs, courses, course offerings, and other content types supported by the Workday Learning catalog.

Input Parameters

integer
Maximum number of objects to return. Default 20, max 100.
integer
Zero-based offset of the first object in the response.
array
Filter by skills associated with the learning content.
array
Filter by topic groups that the learning content belongs to.
array
The type of learning content (programs, blended/digital courses, offerings, etc.).
string
When specified, only learning content updated since this datetime is returned (ISO 8601).
array
The current status of the learning content (Active or Inactive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_LEARNING_CONTENT_LESSONSRetrieves a page of lessons for a learning content item, with limit and offset pagination.

Input Parameters

string
required
The Workday ID of the learning content.
integer
Maximum number of objects to return. Default 20, max 100.
integer
Zero-based offset of the first object in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_LEARNING_RECORDSRetrieves a collection of learning records with filters for completion status, content, expiration window, learner, lifecycle status, and record type.

Input Parameters

integer
Maximum number of objects to return. Default 20, max 100.
integer
Zero-based offset of the first object in the response.
array
Filter by learning content reference.
string
Filter by learning participant (worker reference).
array
Filter by learning record type.
string
Filter by last-updated datetime.
array
Filter by lifecycle status.
array
Filter by record completion status.
string
Filter by expiration date after this date.
string
Filter by expiration date on or before this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_MANAGE_GOALS_CATEGORIESRetrieves Manage Goals category values for use in other Performance Enablement endpoint parameters. Secured by Self-Service: Employee Goals and Worker Data: Employee Goals, with the Performance Enablement scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_MANAGE_GOALS_STATUSRetrieves Manage Goals status values for use in other Performance Enablement endpoint parameters. Secured by Self-Service: Employee Goals and Worker Data: Employee Goals, with the Performance Enablement scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_MENTORSHIPSReturns mentorships viewable by the authenticated user. Supports filtering by mentor, mentee, mentor type, close reason, and lifecycle state (closed / in-progress).

Input Parameters

integer
Maximum number of objects in a single response. Default is 20, maximum is 100.
boolean
Filter by closed state (true returns closed mentorships).
array
Filter by mentee worker instance IDs.
array
Filter by mentor worker instance IDs.
integer
Zero-based index of the first object in a response collection. Default is 0.
boolean
Filter by in-progress state (true returns mentorships with an in-progress event).
array
Filter by mentor type instance IDs.
array
Filter by close mentorship reason instance IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_MESSAGE_TEMPLATESRetrieves a paginated list of message templates. Supports filtering by active/inactive state, name substring, and notification type. Use when building a template picker or discovering existing templates before creating/updating one.

Input Parameters

string
Filter results to message templates whose name contains this string (case-insensitive substring match).
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. Use offset with limit to page through results.
boolean
If true, also include inactive (disabled) message templates in the response.
string
Filter results to message templates that target this notification type, by its Workday ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_MINIMUM_WAGE_RATESRetrieves a collection of minimum wage rates. Filter by country, tax authority, and effective date; toggle includeLocalTaxAuthorities to add city/county rates on top of federal and state-level rates.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
The Workday ID of the country for the minimum wage rates. You can use a returned id from GET /values/minimumWageRatesGroup/countries. You can specify a single country.
string
The effective date for the minimum wage rates, using the date format yyyy-mm-dd.
array
The Workday ID of the payroll tax authority for the minimum wage rates. You can use a returned id from GET /values/minimumWageRatesGroup/taxAuthorities. Repeat the parameter to filter by multiple tax authorities.
boolean
If true, returns minimum wage rates for local tax authorities (cities, counties) in addition to federal and state rates. If false (default), only federal and state rates are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_ACADEMICRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_HEREDITARYRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_HONORARYRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_PROFESSIONALRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_RELIGIOUSRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_ROYALRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_SALUTATIONRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_SOCIALRetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NAME_COMPONENTS_TITLERetrieves instances that can be used as values for other endpoint parameters in this service. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Name. Scope: Contact Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_NOTIFICATION_TYPESRetrieves the list of notification types (the categories that a message template can target, e.g. recruiting emails or onboarding push notifications). Use when populating the notificationType reference required by Create/Update Message Template.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_O_AUTH_CLIENT_DETAILSReturns OAuth client details for OCFR (OAuth Client Federated Registration) clients. Optionally filter by client_name. Use to look up the OAuth endpoints configured for a Workday OCFR client.

Input Parameters

string
Filter by client name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ONE_TIME_PAYMENT_PLANSRetrieve the compatible Compensation v3 REST plan values and one bounded page of detailed amount- and percent-based plans through Compensation v46.0 Get_One-Time_Payment_Plans. Reuse a stable as_of_entry_datetime and increment page to retrieve subsequent detailed pages.

Input Parameters

integer
One-based Workday result page.
integer
Number of plans to return, from 1 through 999.
array
Specific one-time payment plans to retrieve. Do not combine with include_inactive.
boolean
Whether to include inactive one-time payment plans.
string
Effective date for plan configuration. Workday defaults to today.
string
Stable entry timestamp to reuse when retrieving later pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ONE_TIME_PAYMENT_REASON_CANDIDATESList one bounded page of tenant-wide General Event Subcategory references through Integrations Get_References v46.2. The fixed reference type cannot be changed by the caller, results are candidates rather than guaranteed eligible reasons, and additional pages require an explicit follow-up call using the returned page metadata and stable as_of_entry_datetime.

Input Parameters

integer
One-based Workday page, capped at 100.
integer
Maximum candidates requested on this single page, from 1 through 100. This tool does not fetch subsequent pages automatically.
string
Stable Workday entry timestamp. Reuse the returned value for later pages; required when page is greater than 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ORGANIZATION_GOAL_GOAL_PERIODSRetrieves organization goal period instances for use as values in Workday Performance Enablement endpoint parameters. Secured by Self-Service: Organization Goals and Worker Data: Organization Goals, with the Performance Enablement scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ORGANIZATION_GOAL_ORGANIZATIONSRetrieves organization instances for use as organization goal parameter values in the Workday Performance Enablement service. Secured by Self-Service: Organization Goals and Worker Data: Organization Goals, with the Performance Enablement scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ORGANIZATION_GOAL_SUPPORTING_INITIATIVESRetrieves supporting initiative instances for use as organization goal parameter values in the Workday Performance Enablement service. Secured by Self-Service: Organization Goals and Worker Data: Organization Goals, with the Performance Enablement scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ORGANIZATIONS2Retrieves the collection of organizations from the Workday Common API v1. Use when you need to list organizations available in the Workday tenant, optionally filtered by an organization type ID. Supports pagination via the limit and offset parameters.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. Use offset with the limit parameter to control paging.
string
The Workday ID (or reference id) of an organization type to filter the returned organizations by. Get valid ids from the List Organization Types action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_ORGANIZATION_TYPESRetrieves a page of organization types from the Workday Common API, with limit and offset pagination. Use the returned values for filtering or categorizing organization assignment changes in Workday staffing.

Input Parameters

integer
The maximum number of objects in a single response. The default is 25. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAY_GROUP_DETAILSRetrieves a collection of pay group details. Filter by run categories or page through results with limit/offset. Use these IDs as input to the Get Pay Group Detail action for the full payRunGroup / period schedule payload.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
array
One or more Workday IDs of run categories for the pay group. You can use returned ids from GET /values/payrollInputsGroup/runCategories. Repeat the parameter to filter by multiple run categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAY_GROUPSRetrieves a collection of pay groups. Inactive and External Pay Groups are not supported.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAYMENT_ELECTION_ENROLLMENTSRetrieve one page of Workday Cash Management v46.0 payment election enrollments using mandatory, reference-scoped official WID or IID enrollment references. The current Workday Request_Criteria has no worker or role fields; omitting references makes the request tenant-wide, which this action does not support. Returns payment elections, direct-deposit routing, distribution, and bank account fields. This response contains sensitive financial data and must be handled accordingly.

Input Parameters

integer
One-based page number. Pages after page 1 require as_of_entry_datetime.
integer
Number of enrollment records to return in this page, from 1 through 999.
boolean
Whether Workday should include enrollment references in the response.
boolean
Deprecated compatibility field. Only false is accepted and it is not sent to Workday; enrollment_references remain required.
string
Effective date for the returned application data; Workday defaults to today.
string
Entry moment for the result set. Keep this value unchanged across pages to obtain a stable paginated result set.
array
required
Reference-scoped selection of one or more payment election enrollments by official WID or IID. References are mandatory: the current Workday Request_Criteria has no worker or role fields, so omitting references makes the request tenant-wide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAYROLL_INTERFACE_PAY_GROUP_PERIODSRetrieves a paginated collection of payroll periods for the specified Payroll Interface pay group, sorted in descending order by period end date. Optionally filter to a specific period end date or to the 5 most recent periods.

Input Parameters

string
required
The Workday ID of the pay group.
integer
Maximum number of objects in a single response (default 20, max 100).
integer
Zero-based index of the first object in the response collection.
string
Filter to a specific pay period end date (yyyy-mm-dd). Not compatible with showMostRecentOnly.
boolean
If true, return only the 5 most recent pay periods. Not compatible with periodEndDate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAYROLL_INTERFACE_PAY_GROUPSRetrieves a paginated, alphabetically sorted collection of Payroll Interface pay groups from Global Payroll v1. Use to enumerate the pay groups configured in the tenant.

Input Parameters

integer
Maximum number of objects in a single response (default 20, max 100).
integer
Zero-based index of the first object in the response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAYROLL_JOBSRetrieves a collection of jobs visible to the payroll API. Use this to enumerate jobs whose pay group, location, or worker assignment can then be drilled into with the per-job and job-pay-group endpoints. Pagination is controlled with limit/offset.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PAYROLL_RESULTSLists one page of Workday Payroll v46.0 payroll results by payroll result references or date-based criteria. Pages after the first require an as-of entry datetime, kept unchanged across pages.

Input Parameters

integer
One-based Workday result page.
integer
Maximum payroll results in this page.
string
required
Choose one payroll-result selector: explicit payroll result references or date-based criteria.
boolean
Include quarter-to-date amounts in payroll result detail.
boolean
Include year-to-date amounts in payroll result detail.
boolean
Include worker name data in payroll results.
string
Entry moment for the result set. Keep this value unchanged across pages; it is required after the first page.
boolean
Include worker national ID data in payroll results.
boolean
Include payroll worktag data in payroll results.
boolean
Include withholding order data in payroll results.
Include related calculation result detail for earning and deduction lines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PEOPLERetrieves a list of people in the Workday tenant. Use when you need to find people, search for workers by name or ID, or retrieve a comprehensive list of personnel in the organization. This action supports pagination using limit and offset parameters, search filtering by name or person ID, and optionally includes terminated workers in the results.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
Searches people by name or person ID. The search is case-insensitive.
boolean
Include terminated workers in the output. When true, the response will include workers who have been terminated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PERFORMANCE_WORKERSLists worker references through the Workday Performance Enablement REST API, with search, filtering and pagination. Each returned reference exposes an ID, descriptor and API URL.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
string
Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.
boolean
Only return workers whose supervisory organizations are visible to the processing user. This requires the ‘Enable Restrictions on Worker Prompts Based on Supervisory Org Visibility Settings’ setting to be enabled in Edit Tenant Setup - System.
boolean
Include terminated workers in the output

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_PERIOD_SCHEDULESRetrieve Workday Payroll period schedules and their period details.

Input Parameters

integer
One-based page number. Workday defaults to page 1.
integer
Number of period schedules to return, from 1 through 999.
string
Effective date for the returned application data. Workday defaults to today.
string
Entry date and time for the result set. Supply the same value on later pages to keep paginated results stable.
array
Optional period schedule references. Omit to retrieve period schedules broadly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_POPULATED_PERSONAL_INFORMATION_COUNTRIESThe set of countries a person has populated with country specific data. Use this action when integrating Workday’s person v4 API and you need to get this specific resource. Secured by: Person Data: Personal Information, Self-Service: Personal Information. Scope: Personal Data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_REFERRAL_REQUISITION_CANDIDATESReturn one bounded page of candidate requisition references from active, non-future job postings using Recruiting SOAP v46.2 Get_Job_Postings. Only linked requisitions where Primary_Posting=true are returned. Use response_results and a stable as_of_entry_datetime to request another page. These results do not prove that a requisition accepts referrals or is eligible for a particular worker or candidate. This does not enumerate job areas; use List Job Families with includeInactive=false for active job-area candidates.

Input Parameters

integer
One-based Workday page to return, bounded from 1 through 100.
integer
Maximum active postings to inspect on this page, from 1 through 100.
string
Optional effective date for active job postings.
string
Stable entry timestamp. Required after page 1 and reused across pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_RELATES_TO_VALUESRetrieves instances that can be used as values for other endpoint parameters in this service. Secured by: Self-Service: Role Requested Feedback, Self-Service: Self Requested Feedback, Worker Data: Role Requested Feedback, Worker Data: Self Requested Feedback Scope: Performance Enablement, Worker Profile and Skills. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_REQUESTSRetrieves a paginated collection of in-progress requests filtered by the specified parameters. Results are scoped to the processing person’s View access. Use resolution to retrieve closed requests as well.

Input Parameters

integer
Maximum number of objects in a single response. Default 20, max 100.
integer
Zero-based index of the first object in the response. Default 0.
array
WIDs of the persons who initiated the request(s). Multiple values supported.
string
Request ID (per the ID generator format).
string
Workday ID of the person the request was initiated on behalf of.
array
Workday IDs of resolution. Multiple values supported. Valid values: 00000000000000000000000000000104 (Done), 00000000000000000000000000000108 (Duplicate), 00000000000000000000000000000109 (Denied), 00000000000000000000000000000107 (Canceled).
array
Workday IDs of request types. Multiple values supported.
array
Workday IDs of request subtypes. Multiple values supported.
array
Workday IDs of resolution details. Multiple values supported.
string
Return only requests completed on or after this date (YYYY-MM-DD).
string
Return only requests initiated on or after this date (YYYY-MM-DD).
array
Workday IDs of the business object associated with the request.
string
Return only requests completed on or before this date (YYYY-MM-DD).
string
Return only requests initiated on or before this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_REQUEST_TYPESRetrieves request types accessible to the processing person, secured by Initiate access. Call GET /types/{ID} to retrieve full questionnaire details for a specific request type.

Input Parameters

integer
Maximum number of objects in a single response. Default 20, max 100.
integer
Zero-based index of the first object in the response. Default 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_REQUISITION_TEMPLATESRetrieves a paginated collection of requisition templates. Use to power template pickers or to enumerate reusable requisition starting points.

Input Parameters

integer
Maximum number of templates to return. Default 20, max 100.
integer
Zero-based offset for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SCORECARD_RESULTSLists Workday Compensation scorecard results, including available status and type information, with limit and offset pagination. A 404 response is returned as an empty list with total zero.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SEND_BACK_TO_VALUESRetrieves the value instances that can be used as the to field when sending back a business process event step. Use this as a lookup before calling the sendBack action — the returned IDs are the valid targets for the step’s to reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SUCCESSION_PLAN_EVENTSRetrieves all the information for succession plan events. You must specify a succession plan ID via the successionPlan query parameter to retrieve related events; otherwise the response is blank.

Input Parameters

integer
Maximum number of objects in a single response. Default is 20, maximum is 100.
integer
Zero-based index of the first object in a response collection. Default is 0.
string
The succession plan instance ID. You must specify a succession plan ID to retrieve related events; otherwise the response is blank.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SUCCESSION_PLAN_MEMBER_VALUESRetrieves the available succession plan member instances that can be used as values for other Talent Management endpoint parameters. Use this to discover valid member IDs when constructing succession plan or candidate requests.

Input Parameters

integer
Maximum number of objects in a single response. Default and maximum is 1000.
integer
Zero-based index of the first object in a response collection. Default is 0.
string
Search string matching display IDs. Case-insensitive; matches words that start with the given string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SUCCESSION_PLAN_READINESS_VALUESRetrieves the available succession plan readiness instances that can be used as values for other Talent Management endpoint parameters (for example, when setting the readiness field on a succession plan candidate).

Input Parameters

integer
Maximum number of objects in a single response. Default and maximum is 1000.
integer
Zero-based index of the first object in a response collection. Default is 0.
string
Search string matching display IDs. Case-insensitive; matches words that start with the given string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SUCCESSION_PLANSReturns succession plans viewable by the authenticated user. Use this to enumerate active succession plans, optionally filtered by position, when building Talent Management workflows.

Input Parameters

integer
Maximum number of objects in a single response. Default is 20, maximum is 100.
integer
Zero-based index of the first object in a response collection. Default is 0.
string
Position ID used to filter succession plans to a specific position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SUCCESSION_PLAN_STRATEGY_VALUESRetrieves the available succession plan strategy instances that can be used as values for other Talent Management endpoint parameters (for example, when setting the strategy field on a succession plan candidate).

Input Parameters

integer
Maximum number of objects in a single response. Default and maximum is 1000.
integer
Zero-based index of the first object in a response collection. Default is 0.
string
Search string matching display IDs. Case-insensitive; matches words that start with the given string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SUPERVISORY_ORGANIZATIONSRetrieves a collection of supervisory organizations from Workday. Use when you need to list all supervisory organizations in the organization hierarchy, optionally paginated with limit and offset parameters, and optionally including inactive organizations.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
boolean
If true, this method returns the inactive organizations. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_SYSTEM_METRICS_OVERVIEWRetrieves a collection of system metrics overview snapshots — queued tasks, running tasks, and active user sessions. Use for monitoring overall Workday system load.

Input Parameters

integer
The maximum number of objects in a single response. Default 20, max 100.
integer
Zero-based index of the first object in the response. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_TAX_RATESLists company SUI (State Unemployment Insurance) rate references, optionally filtered by company, state authority tax code, and effective date. Returned entries contain only ID, descriptor, and href.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
array
Company reference IDs or WIDs to filter by. Repeat the company query parameter to filter by more than one company. Example: company=comp1&company=comp2&company=00000000000000000000000000000029.
string
The effective date for the SUI rate, using the yyyy-mm-dd format.
array
State FIPS codes or WIDs to filter by. Repeat the payrollStateAuthorityTaxCode query parameter to filter by more than one state. Example: payrollStateAuthorityTaxCode=06&payrollStateAuthorityTaxCode=3b3d378d5f4a48b8b3ac46fee…

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_TEMPLATE_FOR_MY_PERFORMANCE_REVIEWRetrieves instances that can be used as values for other endpoint parameters in this service. Secured by: Self-Service: Performance Reviews Scope: Performance Enablement. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_TIME_CLOCK_EVENTSReturn one bounded page of time clock events for workers and a date range, with up to limit events. To continue, make an independent call with offset advanced by the number returned. Requires the Workday Time Tracking scope and access to the Process: Time Clock Event REST API’s security domain.

Input Parameters

integer
Maximum events in this one bounded page, from 1 to 100.
integer
Zero-based index of the first event in this page. To continue, make an independent call with offset advanced by the number of events returned.
string
End date, inclusive, in YYYY-MM-DD format.
array
Worker IDs to filter by. Each value is sent as a repeated worker query parameter.
string
Start date, inclusive, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_TIME_CLOCK_OPTIONSReturns fixed time clock event types and one bounded page each of in/out time entry codes and time zones for a worker and date. The same offset is applied independently to both dynamic collections; Workday Time Tracking permission is required.

Input Parameters

string
required
Effective date used to evaluate the worker’s eligible values.
integer
Maximum values in each independently bounded Workday collection, up to 1000.
integer
Zero-based offset sent to both endpoints. Each collection independently skips this many values; this is not one combined offset.
string
Optional case-insensitive display-ID prefix search.
string
required
Workday worker ID used to scope eligible time entry codes and time zones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKED_TIME_OPTIONSReturn one Workday page each of time entry codes, worker time zones, projects, and project plan tasks eligible for a worker on a date. limit and offset apply independently to all four collections; call again with a larger offset when a collection has more results. Pass returned time-zone references as in_time_zone and out_time_zone to CREATE_WORKER_TIME_BLOCK; set api_version=“v6” for a v6 in/out entry. General discovery omits inOutCodeOnly. Set project_id to narrow project plan tasks. Requires the Time Tracking scope and Process: Time Block REST APIs security domain.

Input Parameters

string
required
Effective date used to evaluate all returned Worked Time options.
integer
Maximum references returned by each endpoint, from 1 through 1000.
integer
Zero-based offset applied independently to each endpoint.
string
Optional case-insensitive display-ID prefix search applied to every collection.
string
required
Workday worker ID used to scope all returned Worked Time options.
string
Optional project ID used only to filter project plan tasks to that project.
boolean
When true, return only in/out time entry codes. Omit for general Worked Time discovery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_ANYTIME_FEEDBACK_EVENTSRetrieves a page of feedback given events about the specified worker via the Performance Enablement REST API. The returned items contain only ID, descriptor, and href references.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_DEPENDENTSRetrieve a worker’s dependents with the official Workday Human_Resources v46.0 Get_Workers SOAP operation and Include_Related_Persons=true. Returns only explicitly normalized dependent identity, name, demographic, relationship, and status fields.

Input Parameters

integer
One-based Workday response page to return. Pages after the first require as_of_entry_datetime.
integer
Number of Worker objects to return per page (1-999).
string
required
Worker identifier to pass in Worker_Reference/ID.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Official Workday WorkerObject ID type used for worker_id.
string
Entry timestamp for the result set. Required after page 1 and reused across pages to keep paginated results stable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_DEVELOPMENT_ITEMSRetrieves a page of development item references for the specified worker via the Performance Enablement REST API. Each returned item contains only ID, descriptor, and href.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_GOAL_EVENTSGet Worker Goal Events. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_GOALSRetrieves a collection of goals for a specific worker. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_INBOX_TASKSRetrieves a collection of inbox tasks for a specific Workday worker.

Input Parameters

string
required
The Workday ID of the worker resource. Use me for the authenticated worker.
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. Use offset with limit to page through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_REQUESTED_FEEDBACK_ON_SELF_EVENTSRetrieves a collection of self-requested feedback events for the specified worker. Use when you need to read this Workday data via the Performance Enablement REST API.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKERSRetrieves a collection of workers and current staffing information.

Input Parameters

integer
The maximum number of objects in a single response. The default is 20. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.
string
Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.
boolean
Include terminated workers in the output

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKERS2Retrieves a collection of workers and current staffing information from the Time Tracking service. Use to list workers eligible for time-tracking operations.

Input Parameters

integer
Maximum number of results to return. Default is 20, maximum is 100.
integer
Zero-based index of the first object in a response collection. Default is 0.
string
Search workers by name or worker ID. Case-insensitive; space-delimited search strings form an OR search.
boolean
Only return workers whose supervisory organizations are visible to the processing user.
boolean
Include terminated workers in the output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_SERVICE_DATESRetrieves service dates for a specified worker from Workday Staffing API. Use when you need to get hire date and continuous service date information for a worker identified by their Workday ID. This action returns a list of service date records that can be paginated using limit and offset parameters.

Input Parameters

string
required
The Workday ID of the worker resource. Can be obtained from ‘List Workers’ or ‘Get Current User’ actions.
integer
The maximum number of objects in a single response. The default is 25. The maximum is 100.
integer
The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKERS_TO_NOTIFY_VALUESRetrieves instances that can be used as values for other endpoint parameters in this service. Secured by: Worker Data: Anytime Feedback Scope: Performance Enablement, Worker Profile and Skills. Use when you need to read this Workday data via the Performance Enablement REST API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WORKER_TIME_BLOCKSRetrieves time blocks for specified workers over a date range. Does not return incomplete time blocks, time offs, or overtime request blocks. Filter by worker, project, phase, task, status, and date range.

Input Parameters

integer
Maximum number of objects in a single response. Default is 20, maximum is 100.
array
Filter by Workday ID of project plan phase. Multiple values allowed.
integer
Zero-based index of the first object in a response collection. Default is 0.
array
Filter by approval status Workday ID. Submitted: 00000000000000000000000000000111; Unsubmitted: 00000000000000000000000000000110; Approved: 00000000000000000000000000000100; Denied: 00000000000000000000000000000106; Sent Back: 00000000000000000000000000000101.
string
End date (YYYY-MM-DD) of the time block date range.
array
Filter by Workday ID of worker. Multiple values allowed.
array
Filter by Workday ID of project. Multiple values allowed.
string
Start date (YYYY-MM-DD) of the time block date range.
array
Filter by Workday ID of project plan task. Multiple values allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WQL_DATA_SOURCE_FIELDSRetrieves the fields available on a WQL data source, including each field’s related business object. Use this when discovering selectable columns for building a WQL query.

Input Parameters

string
required
The Workday ID of the data source whose fields to list.
string
Alias of the data source field to retrieve.
integer
Maximum number of fields in a single response. Default 20, max 100.
integer
Zero-based index of the first field in the response. Default 0.
string
Case-insensitive search string within field descriptors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WQL_DATA_SOURCE_FILTERSRetrieves the filters available on a specific WQL data source. Use this to discover which filters you can apply to a data source when building a WQL query.

Input Parameters

string
required
The Workday ID of the data source whose filters to list.
string
Alias of the data source filter to retrieve.
integer
Maximum number of filters in a single response. Default 20, max 100.
integer
Zero-based index of the first filter in the response. Default 0.
string
Case-insensitive search string within filter descriptors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LIST_WQL_DATA_SOURCESRetrieves a collection of WQL data sources with their primary business objects. Use this when building or discovering data sources to query in Workday Query Language (WQL). You can only see data sources you have security access to.

Input Parameters

string
The alias of the data source.
integer
The maximum number of objects in a single response. Default 20, max 100.
integer
Zero-based index of the first object in the response. Default 0.
string
Case-insensitive search string within data source descriptors.
string
Filter “Indexed” and “Non-indexed” data sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_LOAD_EMPLOYEE_REVIEWSBulk-loads employee reviews into Workday Performance Management as an asynchronous EIB import. Acceptance does not establish final import success; the returned import process reference can be used to check the outcome.

Input Parameters

array
required
List of employee reviews to load. Each item must contain the child fields of a Workday Employee_Review_Data element directly; do not include an outer Employee_Review_Data key because Composio adds that wrapper. Each item must include Worker_Reference and Employee_Review_Template_Reference. Other supported fields include Employee_Review_ID, Review_Completed, Manager_Reference, Review_Initiation_Date, Review_Period_Start_Date, Review_Period_End_Date, and the review section data elements. Include Manager_Reference when Review_Completed is true. Use a unique Employee_Review_ID for each new review. Include both review period dates when the selected template does not define them; omit them when the template defines the period. Use Workday SOAP element names as keys, nested dicts/lists for child elements, @name keys for XML attributes, and #text for element text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_MANAGE_GOALSExecutes manage goals in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if matching goals already exist.
object
required
Workday Manage_Goals_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
object
Optional Workday Business_Process_Parameters object. Use Workday SOAP element names as keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_CASEEdits a single Help case instance with the specified data. Supports updating status, substatus, type, flag, assignee, service team, and labels in a single call.

Input Parameters

string
required
The Workday ID of the case to edit.
object
A simple Workday id reference.
object
A simple Workday id reference.
object
A simple Workday id reference.
array
Replacement list of case label references.
object
A simple Workday id reference.
boolean
Whether to reroute the case after the case type changes.
object
A simple Workday id reference.
object
A simple Workday id reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_EXPENSE_ENTRYPartially updates an existing Quick Expense entry in Workday Expense v1. Only the fields provided in the request are modified; everything else is left untouched. Use this for targeted edits (e.g. changing just the memo or just the amount) without having to re-submit the full entry as Update Expense Entry (PUT) requires.

Input Parameters

string
required
The Workday ID of the Quick Expense entry to update.
string
New transaction date for the entry (YYYY-MM-DD).
string
New free-form memo for the expense entry.
object
A Workday instance reference (id / descriptor / href).
object
New amount for the expense entry (Workday Currency object — typically {"value": <amount>, "currency": {"id": <WID>}}).
string
New merchant name for the expense entry.
array
Optional list of attachments (e.g. receipt images) to associate with the entry.
object
Expense item (category) reference for the Quick Expense.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_GIVE_REQUESTED_FEEDBACK_EVENTUpdates the existing Give Requested Feedback Event instance with the specified ID. The current authenticated user is a responder for the event. Use when you need to partially update this Workday resource via the Performance Enablement REST API. The spec’s request body schema for this op resolves to no documented properties; pass a free-form JSON object via the body field matching Workday’s public field names.

Input Parameters

string
required
The Workday ID of the resource.
object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_MESSAGE_TEMPLATE_BY_IDPartially updates an existing message template. Unlike Update Message Template By ID (PUT), this only modifies the fields you provide and leaves the rest unchanged. Use when toggling inactive, renaming, or tweaking a single subject line.

Input Parameters

string
required
The Workday ID of the message template to update.
string
New name for the message template.
boolean
Indicates whether the template is active or has been disabled.
string
A preview of the instance.
object
Container for push notification data, used in REST API.
object
Email Configuration container for REST API.
string
The Reference ID to use for lookups within Workday Web Services.
object
Notification Type indicates where the template can be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_ORGANIZATION_GOALPartially updates a single organization goal instance with the specified data. Use when you need to partially update this Workday resource via the Performance Enablement REST API. The spec’s request body schema for this op resolves to no documented properties; pass a free-form JSON object via the body field matching Workday’s public field names.

Input Parameters

string
required
The Workday ID of the resource.
object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_PAYROLL_INTERFACE_PAY_GROUP_PERIODPartially updates an existing payroll period for a Payroll Interface pay group with the provided fields. Typical use: flip a pay period’s status (e.g., reopen or close it) or adjust its dates.

Input Parameters

string
required
The Workday ID of the pay group.
string
New status for the pay period (e.g., ‘Closed’, ‘Open’).
string
New end date for the pay period (yyyy-mm-dd).
string
required
The Workday ID of the pay period to update.
string
New start date for the pay period (yyyy-mm-dd).
boolean
Whether this period is the earliest open pay period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PATCH_WORKER_DEVELOPMENT_ITEMPartially updates a worker’s development item via the Performance Enablement REST API using a free-form JSON body. The response exposes the item’s ID, descriptor, and href.

Input Parameters

string
required
The Workday ID of the resource. - ID: Replace with your actual Workday ID - me
object
required
Request body. The spec’s body schema for this endpoint resolves to no documented properties; pass a free-form JSON object mirroring Workday’s public field names (id-bearing instance references for related objects, plain values otherwise).
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_POST_WQL_QUERYRuns a read-only WQL query using POST, allowing queries longer than 2,048 characters, subject to Workday security. The response exposes query and ad hoc query identifiers rather than query result rows.

Input Parameters

string
The WQL query to execute. POST accepts queries longer than 2,048 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_CERTIFICATIONExecutes put certification in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Certification reference identifier for updates/deletes.
object
required
Workday Certification_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for certification_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_CERTIFICATION_ISSUERExecutes put certification issuer in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Certification Issuer reference identifier for updates/deletes.
object
Workday Certification_Issuer_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for certification_issuer_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_CHECK_INExecutes put check in in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Check In reference identifier for updates/deletes.
object
Workday Check-In_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for check_in_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_CHECK_IN_TOPICExecutes put check in topic in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Check In Topic reference identifier for updates/deletes.
object
required
Workday Check-In_Topic_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for check_in_topic_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_COMPETENCYExecutes put competency in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Competency reference identifier for updates/deletes.
object
Workday Competency_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for competency_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_COMPETENCY_CATEGORYExecutes put competency category in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Competency Category reference identifier for updates/deletes.
object
Workday Competency_Category_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for competency_category_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_DEGREEExecutes put degree in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Degree reference identifier for updates/deletes.
object
required
Workday Degree_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for degree_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_FEEDBACK_BADGEExecutes a put feedback badge operation in Workday Performance Management, with an option to request deletion of the referenced badge.

Input Parameters

boolean
Whether Workday should delete the referenced object when supported by this operation.
boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Feedback Badge reference identifier for updates/deletes.
object
required
Workday Feedback_Badge_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for feedback_badge_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_FEEDBACK_QUESTIONExecutes a put feedback question operation in Workday Performance Management, with an option to request deletion of the referenced question.

Input Parameters

boolean
Whether Workday should delete the referenced object when supported by this operation.
string
Optional Feedback Question reference identifier for updates/deletes.
object
required
Workday Feedback_Question_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for feedback_question_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_FIELD_OF_STUDYExecutes put field of study in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Field Of Study reference identifier for updates/deletes.
object
Workday Field_Of_Study_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for field_of_study_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_GOAL_PAYOUT_BANDExecutes put goal payout band in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Goal Payout Band reference identifier for updates/deletes.
object
required
Workday Goal_Payout_Band_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for goal_payout_band_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_GOAL_UNITExecutes a put goal unit operation in Workday Performance Management, with an option to request deletion of the referenced goal unit.

Input Parameters

boolean
Whether Workday should delete the referenced object when supported by this operation.
string
Optional Goal Unit reference identifier for updates/deletes.
object
required
Workday Goal_Unit_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for goal_unit_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_ORGANIZATION_GOALExecutes put organization goal in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Organization Goal reference identifier for updates/deletes.
object
required
Workday Organization_Goal_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for organization_goal_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_REVIEW_QUESTIONExecutes a put review question operation in Workday Performance Management, with an option to request deletion of the referenced question.

Input Parameters

boolean
Whether Workday should delete the referenced object when supported by this operation.
string
Optional Review Question reference identifier for updates/deletes.
object
required
Workday Review_Question_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for review_question_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_REVIEW_QUESTION_CATEGORYPuts a review question category in Workday Performance Management, with an optional reference and delete flag.

Input Parameters

boolean
Whether Workday should delete the referenced object when supported by this operation.
string
Optional Review Question Category reference identifier for updates/deletes.
object
required
Workday Review_Question_Category_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for review_question_category_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_REVIEW_TYPEPuts a review type in Workday Performance Management, with an optional reference, add-only setting, and delete flag.

Input Parameters

boolean
Whether Workday should delete the referenced object when supported by this operation.
boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional Review Type reference identifier for updates/deletes.
object
required
Workday Review_Type_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for review_type_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_PUT_SCHOOL_TYPEExecutes put school type in Workday Performance Management.

Input Parameters

boolean
When true, Workday treats the request as add-only and fails if the referenced object already exists.
string
Optional School Type reference identifier for updates/deletes.
object
required
Workday School_Type_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
string
Identifier type for school_type_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_REASSIGN_BUSINESS_PROCESS_EVENT_STEPReassigns the specified business process event step to a different set of awaiting persons and/or roles. Use this to route a step that landed on the wrong assignee — add or remove specific person IDs, or change the awaiting role. The caller must have reassign permission on the step.

Input Parameters

string
required
The Workday ID of the business process event step to reassign.
string
Optional comment recorded on the event step explaining the reassignment.
array
List of person reference objects ({id} or {id, descriptor}) to add as assignees on this step.
array
Optional list of role reference objects ({id} or {id, descriptor}) the event step is awaiting after the reassignment.
array
List of person reference objects ({id} or {id, descriptor}) to remove from the step’s assignee list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_REFER_CANDIDATEInitiate Workday Recruiting SOAP v46.2 Refer_a_Candidate for a new candidate. Requires access to the Employee Referrals and Candidate Data security domains and a configured Refer a Candidate (Web Service) business process. Preserves tenant approvals, reviews, notifications, and to-dos, exits on initiation-step validation errors, and never auto-completes the business process.

Input Parameters

object
required
Candidate’s required legal name.
string
Comment about the candidate referral.
object
required
Candidate’s required country and email or complete phone details.
array
One or more enabled Recruiting job areas for this referral.
array
One or more job requisitions for this referral.
object
Configured referral relationship when referral levels are enabled.
string
required
Workday identifier for the referring worker.
Whether the candidate gave referral consent when required by country.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Official Workday WorkerObject identifier type for the referring worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_REMOVE_HOME_CONTACT_INFORMATION_EMAIL_ADDRESSRemoves the specified email address from the home contact information changes. Use when you need to remove a specific home email address that was added during a business process. If this address existed before the start of the current business process, it won’t be removed from the target Person until the parent business process completes. This action is irreversible once the business process completes. Secured by: Person Data: Home Email, Self-Service: Home Email Scope: Contact Information

Input Parameters

string
required
The Workday ID of the home contact information change resource.
string
required
The Workday ID of the email address subresource to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_REPLACE_HOME_CONTACT_CHANGE_ADDRESSUpdates one address staged in a Workday Home Contact Change event by replacing its supported writable address fields. Primary, public, and usage-type settings are preserved. Requires the Contact Information scope and access to Person Data: Home Address or Self-Service: Home Address for the event’s worker.

Input Parameters

string
Deprecated top-level alias; use changes.id.
string
Deprecated top-level alias; use changes.city.
object
Deprecated top-level alias; use changes.usage.
object
Writable fields to change. The tool first reads the staged address and merges these fields into that complete provider representation before PUT.
object
Deprecated top-level alias; use changes.country.
string
required
Home Contact Change event ID returned by the initiate tool.
string
Deprecated top-level alias; use changes.cityLocal.
string
required
Staged address ID returned by the address-list tool.
string
Deprecated top-level alias; use changes.postalCode.
object
Deprecated top-level alias; use changes.countryCity.
string
Deprecated top-level alias; use changes.addressLine1.
string
Deprecated top-level alias; use changes.addressLine2.
string
Deprecated top-level alias; use changes.addressLine3.
string
Deprecated top-level alias; use changes.addressLine4.
string
Deprecated top-level alias; use changes.addressLine5.
string
Deprecated top-level alias; use changes.addressLine6.
string
Deprecated top-level alias; use changes.addressLine7.
string
Deprecated top-level alias; use changes.addressLine8.
string
Deprecated top-level alias; use changes.addressLine9.
object
Deprecated top-level alias; use changes.countryRegion.
integer
Deprecated top-level alias; use changes.numberDaysWFH.
string
Deprecated top-level alias; use changes.citySubdivision1.
string
Deprecated top-level alias; use changes.citySubdivision2.
string
Deprecated top-level alias; use changes.addressLine1Local.
string
Deprecated top-level alias; use changes.addressLine2Local.
string
Deprecated top-level alias; use changes.addressLine3Local.
string
Deprecated top-level alias; use changes.addressLine4Local.
string
Deprecated top-level alias; use changes.addressLine5Local.
string
Deprecated top-level alias; use changes.addressLine6Local.
string
Deprecated top-level alias; use changes.addressLine7Local.
string
Deprecated top-level alias; use changes.addressLine8Local.
string
Deprecated top-level alias; use changes.addressLine9Local.
string
Deprecated top-level alias; use changes.regionSubdivision1.
string
Deprecated top-level alias; use changes.regionSubdivision2.
string
Deprecated top-level alias; use changes.citySubdivision1Local.
string
Deprecated top-level alias; use changes.citySubdivision2Local.
string
Deprecated top-level alias; use changes.regionSubdivision1Local.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_REQUEST_ONE_TIME_PAYMENTInitiate, but do not claim completion or payment of, Workday’s Request One-Time Payment business process through Compensation REST v3. Makes one POST and does not retry the business-process initiation.

Input Parameters

object
required
One-time-payment reason. LIST_ONE_TIME_PAYMENT_REASON_CANDIDATES returns candidates only; verify eligibility before initiating the event.
object
required
Worker position returned by DISCOVER_ONE_TIME_PAYMENT_OPTIONS.
string
required
Worker WID, typed Employee_ID/Contingent_Worker_ID reference, or me.
string
required
Business-process effective date.
array
required
One or more one-time-payment lines.
string
Date on which the compensation change becomes visible to the worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_RESCIND_BUSINESS_PROCESS_EVENTRescinds a completed business process event, undoing its effect on the Workday system. Use this when a completed business process (e.g., a finalized job change) needs to be reversed. The caller must have permission to rescind events of this type under the tenant’s security model.

Input Parameters

string
required
The Workday ID of the business process event to rescind.
string
Optional reason recorded on the event for the rescission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_RETRIEVE_ABSENCE_PLAN_BALANCESRetrieves the balance of all absence plans and leave-of-absence types for the specified worker. Returns balances filterable by worker, category (Leave of Absence / Absence Table / Time Off), and effective date. Use List Workers to find a worker Workday ID first.

Input Parameters

integer
The maximum number of objects in a single response. Default 20, maximum 100.
integer
The zero-based index of the first object in a response collection. Default 0. Use with limit for pagination.
string
The Workday ID of the worker for which balances are returned. Workday documents this as required at the API level even though the spec marks it optional; omitting it typically returns an empty collection. Obtain from List Workers or Get Current User.
string
The Workday ID of the absence type category to filter by. Valid values: Leave of Absence Type (00000000000000000000000000000102), Absence Table (00000000000000000000000000000103), Time Off (00000000000000000000000000000005).
string
The absence balances as of the specified date in yyyy-mm-dd format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_RUN_WQL_QUERYRuns a WQL query via GET, passing the query as a URL parameter. Results are limited to the row ID, descriptor and href fields exposed by the response model; access depends on Workday security.

Input Parameters

integer
Maximum number of result rows in a single response. Default 20, max 100.
string
The WQL query to execute. Example: ‘SELECT worker FROM allWorkers’.
integer
Zero-based index of the first row in the response. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SEND_BACK_BUSINESS_PROCESS_EVENT_STEPSends back the specified business process event step to a prior step in the workflow. Use this when an approver wants to request changes from an earlier participant. Both the reason and the target step ID are required.

Input Parameters

string
required
The Workday ID of the business process event step to send back.
object
required
Reference object ({id} or {id, descriptor}) for the prior step the event should be sent back to. Use list_send_back_to_values to enumerate valid targets.
string
required
Reason recorded on the event step for sending it back. Workday surfaces this as the user comment on the audit trail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SEND_MESSAGESends an ad-hoc message to one or more recipients using Workday’s Connect messaging surface. Unlike Create Message Template (which defines a reusable template), this dispatches an actual message immediately. Use when triggering a one-off notification or announcement.

Input Parameters

string
Communication ID for threading / correlating this message with other Workday communications.
object
Push-notification-channel content for the message.
object
Recipients of the message. Workday’s Connect v2 messageDetail body wraps the recipient list in an object whose contacts field holds the array of subscriber references — not a bare array. Each contact is an instance reference (id/descriptor).
object
Email-channel content for the message. Provide when sending via email (or when overriding the email content of a referenced messageTemplate). subject and body are the minimum useful pair.
object
Override for the message sender. Workday’s Connect v2 sendMessage expects an instance reference ({id, descriptor}) here, not a free-form {name, email} object — passing the latter returns unrecognized field for both keys. Use the WID of an existing Workday worker / person who should appear as the sender.
object
Message-template instance reference ({'id': '<message-template-id>'}) to use as the basis for the email and/or push content.
object
Notification-type instance reference ({'id': '<notification-type-id>'}) used to pick the template/channel routing for the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SEND_SUPPLIER_INVOICE_ATTACHMENTS_FOR_SCANNINGSubmits supplier invoice OCR queue entries for scanning in Workday, with optional priority and external source references. Invoice attachments must already be uploaded separately.

Input Parameters

array
Collection of supplier invoice attachments to send to the OCR scanning queue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_START_PERFORMANCE_REVIEWCreates an in-progress or completed Workday performance review for an employee.

Input Parameters

string
Optional business process comment.
boolean
Whether Workday should run the business process immediately.
string
Optional manager identifier for the manager evaluation subprocess.
string
required
Employee identifier for the worker receiving the performance review.
boolean
Whether Workday should automatically complete the main business process when possible.
string
Optional manager evaluation overall comment.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Identifier type for manager_id.
string
Optional review period end date in YYYY-MM-DD format.
string ("WID" | "Employee_ID")
Identifier type for employee_id.
string
Optional worker identifier to associate with the business process comment.
string
Optional review period start date in YYYY-MM-DD format.
string
required
Employee review template identifier used to start the performance review.
string ("WID" | "Employee_ID" | "Contingent_Worker_ID")
Identifier type for comment_worker_id.
string ("WID" | "Employee_Review_Template_ID")
Identifier type for review_template_id.
string
Optional manager overall rating identifier.
string ("WID" | "Review_Rating_ID")
Identifier type for manager_overall_rating_id.
number
Optional numeric manager overall rating override.
boolean
Whether Workday should discard the transaction on exit validation errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SUBMIT_BUSINESS_PROCESS_EVENT_STEP_QUESTIONNAIRESubmits the Complete Questionnaire action for a Questionnaire-type business process event step. Use this to record the answers on a questionnaire step and move the business process forward. The questionnaireResponse shape is tenant-defined; the spec leaves it as a free-form object.

Input Parameters

string
required
The Workday ID of the questionnaire-type business process event step to submit.
object
Optional step-action reference object ({id} or {id, descriptor}) selecting which submit variant to perform.
object
The questionnaire response payload. Workday’s spec body for this endpoint resolves to an empty schema — pass the response payload your tenant expects (typically an object with a ‘responses’ or ‘answers’ array of {question, response} entries).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SUBMIT_BUSINESS_PROCESS_EVENT_STEP_TO_DOSubmits the action for a ToDo-type business process event step. Use this to mark a ToDo step as done and advance the business process. Pass the stepAction ID returned by the get-step action to select the correct submit variant.

Input Parameters

string
required
The Workday ID of the ToDo-type business process event step to submit.
string
Optional comment recorded with the ToDo submission.
object
required
Step-action reference object ({id} or {id, descriptor}) — for ToDo steps this selects ‘Submit’ (or whichever submit variant the tenant has configured).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SUBMIT_HOME_CONTACT_CHANGESubmit an existing Home Contact Change event and start its Workday business process. The integration user must be allowed to initiate Change Home Contact Information (REST Service) on the Home Contact Change business process and have access to the security domains for the contact information being changed. Workday may return In Progress while approval or later business-process steps remain; do not treat submission as immediate completion.

Input Parameters

string
required
Workday ID of the Home Contact Change event returned when the event was created. This is not an address or other contact-information subresource ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SUBMIT_JOB_CHANGESubmits an in-progress job change for a worker in Workday. Use when you have created a job change event and need to finalize/submit it for processing. This action is irreversible once submitted - the job change will be queued for processing by Workday. Only the person who initiated the Change Job operation can submit it. Must be submitted before the event Initiation step. This action returns 201 Created on successful submission. Review the response status and any validation messages to confirm the submission completed as expected.

Input Parameters

string
required
The Workday ID of the job change resource to submit. This is the identifier for the job change event that was created for a worker.
string
Validation mode. Set to ‘true’ to validate without submitting, or ‘false’ (or omit) to perform the actual submission.
object
Model for business process parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SUBMIT_ORGANIZATION_ASSIGNMENT_CHANGESubmits the organization assignment change event for the specified ID, initiating the Change Organization Assignment business process. Submitting with an empty body is equivalent to clicking the Submit button on the Change Organization Assignment task in Workday. To save for later instead, specify businessProcessParameters.action.id = ‘00000000000000000000000000000110’. This action transitions the event from in-progress to submitted state and is generally irreversible once the business process begins.

Input Parameters

string
required
The Workday ID of the organization assignment change resource to submit.
object
Optional business process parameters object for the submission. May include ‘action’ (reference object) and ‘comment’ fields. An empty body { } (the default when this is omitted) is equivalent to clicking the Submit button on the Change Organization Assignment task in Workday. To save for later, set businessProcessParameters.action.id = ‘00000000000000000000000000000110’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_SUBMIT_WORK_CONTACT_CHANGESubmit the specified contact change ID. Use this action when integrating Workday’s person v4 API and you need to post this specific resource. Secured by: Change Work Contact Information (REST Service). Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Contact Change Event
string
The display name of the instance
object
The businessProcessParameters field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_AN_EXISTING_PAYROLLPartially updates an existing payroll input instance with the specified ID. Before calling this PATCH method, call GET /payrollInputs/{ID} to retrieve the current payroll input information; the fieldEditability field on the GET response determines which fields can be updated (all, none, or endDateOnly). The worker field cannot be updated.

Input Parameters

string
required
The Workday ID of the payroll input instance to update.
string
Comment for the payroll input update.
string
The end date for the payroll input, using the date format yyyy-mm-dd.
boolean
Whether the payroll input is ongoing (recurring) or one-time.
object
Reference to a currency in Workday
object
Reference to a position in Workday
array
List of worktags for the payroll input.
string
The start date for the payroll input, using the date format yyyy-mm-dd.
boolean
Whether this is an adjustment to an existing payroll input.
array
List of input details for the payroll input.
object
Reference to a pay component in Workday
array
List of run categories for the payroll input.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_COMPENSATION_SCORECARDReplaces an existing Compensation Scorecard as of the specified effectiveDate via Workday’s Compensation v3 API. Use to refresh goal weights, rename a scorecard, or rebuild its profile sections. Workday recommends calling Get Compensation Scorecard Info first to seed the request body and then mutating only the fields you intend to change — omitted optional arrays delete previously-set values. Secured by: Set Up: Merit and Bonus. Required body fields: scorecardName, effectiveDate, and a non-empty defaultScorecardGoals[].

Input Parameters

string
required
The Workday ID of the Compensation Scorecard to update.
string
Optional Workday ID or Reference ID echoed in the body; usually omitted because the path ID already identifies the scorecard.
boolean
Replaces the inactive flag as of the specified effectiveDate. Defaults to false in Workday.
string
required
The Effective Date of the updates to the Compensation Scorecard (YYYY-MM-DD).
string
required
Replaces the name of the Compensation Scorecard as of the specified effectiveDate.
array
Replaces the profile sections; if previously set and omitted here, the profiles are deleted as of effectiveDate.
string
Replaces the description; if previously set and omitted here, the description is deleted as of effectiveDate.
array
required
Replaces the array of Default Scorecard Goals as of the specified effectiveDate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_CUSTOM_FIELD_TYPEReplaces an existing custom field type definition (full update via PUT semantics). Use this to change a field type’s configuration in bulk; partial edits should be performed by reading the current instance first and submitting the merged payload here.

Input Parameters

string
required
The Workday ID of the custom field type to replace.
object
required
JSON body of the custom field type that replaces the current instance. Provide all fields per Workday Designer documentation; the spec does not enumerate documented properties for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_CUSTOM_FIELD_TYPE_LIST_VALUEReplaces a single list value on a custom list field type (full update via PUT semantics). Use this to rename or otherwise re-configure an existing list option on a custom list used by custom object definitions.

Input Parameters

string
required
The Workday ID of the custom field type (custom list) that owns the list value.
object
required
JSON body of the list value that replaces the current instance. Provide all fields per Workday Designer documentation; the spec does not enumerate documented properties for this endpoint.
string
required
The Workday ID of the list value to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_CUSTOM_OBJECTUpdates an existing custom object instance. Use this to change field values on a custom object attached to a Workday business object (e.g. updating a worker’s parking space details, or one entry in a worker’s stock grants). The same endpoint serves both single-instance and multi-instance custom object definitions.

Input Parameters

string
required
Either the extended Workday object ID or the custom object’s own ID.
string
required
The web service alias of the custom object. Determine this by running the ‘View Custom Object’ task in Workday. Works for both single-instance and multi-instance custom object definitions.
object
required
Dictionary of custom fields to update. Field types depend on the custom object definition; see the response of a GET call for the exact shape.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_CUSTOM_OBJECT_DEFINITION_CONDITION_RULEReplaces a single condition rule attached to a custom object definition (full update via PUT semantics). Use this when re-configuring a visibility, edit-restriction, or business-logic rule on a custom object.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the condition rule.
object
required
JSON body of the condition rule that replaces the current instance. Provide fields per Workday Designer documentation; the spec does not enumerate documented properties for this endpoint.
string
required
The Workday ID of the condition rule to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_CUSTOM_OBJECT_DEFINITION_FIELDReplaces an existing field on a custom object definition (full update via PUT semantics). Use this when reconfiguring a single column-level attribute on a custom object — for example, switching field type, toggling the required flag, or renaming the field label.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the field.
object
required
JSON body of the field that replaces the current instance. Provide fields per Workday Designer documentation (typically name, alias, fieldType, required); the spec does not enumerate documented properties for this endpoint.
string
required
The Workday ID of the field to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_CUSTOM_OBJECT_DEFINITION_VALIDATIONReplaces a single validation on a custom object definition (full update via PUT semantics). Use this when tightening or relaxing a data-quality / business-rule check attached to a custom object.

Input Parameters

string
required
The Workday ID of the custom object definition that owns the validation.
object
required
JSON body of the validation that replaces the current instance. Provide fields per Workday Designer documentation (typically name, the expression, and the error message); the spec does not enumerate documented properties for this endpoint.
string
required
The Workday ID of the validation to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_EMPLOYEE_REVIEW_RATINGUpdates manager rating inputs for a Workday employee review.

Input Parameters

string
Optional employee review data ID. Use when not providing employee_review_id.
string
Optional overall manager comment for the review.
string
Optional overall review rating identifier.
string ("WID" | "Review_Rating_ID")
Identifier type for rating_id.
number
Optional manual numeric overall rating override.
array
Optional manager rating and comment data by review section.
string
Optional employee review identifier. Workday uses this reference before the data ID when both are provided.
string ("WID" | "Employee_Review_ID")
Identifier type for employee_review_id.
boolean
Whether to override the calculated overall review rating.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_EXPENSE_ENTRYUpdates (replaces) an existing Quick Expense entry in Workday Expense v1. This is a PUT, so the supplied body fully replaces the existing entry — fields omitted in the request will be cleared. Use this for full-rewrite edits to an entry (e.g. re-keying the merchant, date, amount, and expense item at once). For partial updates use Patch Expense Entry instead.

Input Parameters

string
required
The Workday ID of the Quick Expense entry to update.
string
required
Transaction date for the expense entry (YYYY-MM-DD).
string
Free-form memo to attach to the expense entry.
object
A Workday instance reference (id / descriptor / href).
object
Amount for the expense entry (Workday Currency object — typically {"value": <amount>, "currency": {"id": <WID>}}).
string
Name of the merchant for the expense entry.
array
Optional replacement list of attachments (e.g. receipt images) for the entry.
object
Expense item (category) reference for the Quick Expense.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_HOME_CONTACT_CHANGE_EMAIL_ADDRESSPartially update an existing email address that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Home Email, Self-Service: Home Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Email Reference
object
The usage field.
string
The display name of the instance
string
The email address.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_HOME_CONTACT_CHANGE_INSTANT_MESSENGERPartially update an existing instant messenger that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Home Instant Messenger, Self-Service: Home Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Instant Messenger Reference
object
The type field.
object
The usage field.
string
The instant messenger account username.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_HOME_CONTACT_CHANGE_PHONE_NUMBERPartially update an existing phone number that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Home Phone, Self-Service: Home Phone. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Phone Reference
object
The usage field.
string
The phone extension.
string
The display name of the instance
object
The deviceType field.
string
required
The Workday ID of the subresource.
object
The countryPhoneCode field.
string
The complete phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_HOME_CONTACT_CHANGE_WEB_ADDRESSPartially update an existing web address that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Home Web Address, Self-Service: Home Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Web Address Reference
string
The complete URL address for the web address.
object
The usage field.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGE_BUSINESS_TITLEPartially updates the business title for an in-progress job change; the update does not persist until the job change request is submitted. This operation is available only to the person who initiated the Change Job operation and must be submitted before the event Initiation step.

Input Parameters

string
required
The Workday ID of the job change resource. This is the identifier for the job change event that was created for a worker.
string
required
The new business title value to update for the job change. This is a free-text field representing the employee’s business title.
string
required
The Workday ID of the business title subresource. For singleton subresources like businessTitle, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGE_COMMENTPartially updates the comment for an in-progress job change; the update does not persist until the job change request is submitted. This operation is available only to the person who initiated the Change Job operation and must be submitted before the event Initiation step.

Input Parameters

string
required
The Workday ID of the job change resource. This is the identifier for the job change event that was created for a worker.
string
required
The updated comment text for the job change. This is a free-text field representing the comment to be associated with the job change event.
string
required
The Workday ID of the comment subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_ADMINISTRATIVEPartially updates the administrative options for the specified job change ID. Use when modifying administrative details (FTE, weekly hours, worker/time type, end employment date, etc.) for an in-progress Workday Staffing job change. Only the person who initiated the Change Job operation can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
number
Full Time Equivalent for a worker (scheduled weekly hours / default weekly hours).
number
The paid full time equivalent for the worker as of the effective date.
string
The date that the employee should be notified for a termination (ISO 8601 date).
object
The time type for the worker as of the effective date.
object
The work-study program for the worker as of the effective date.
number
The working full time equivalent for the worker as of the effective date.
object
The pay rate type for the worker as of the effective date. Provide an instance reference (e.g. {‘id’: ‘<wid>’}).
string
required
The Workday ID of the administrative subresource. For singleton subresources like administrative, this typically matches the job change ID.
object
The assignment type for the worker as of the effective date.
string
The first day of work for the worker (ISO 8601 date).
boolean
True if paid full time equivalent is specified on a worker as of the effective date.
string
The new End Employment Date for the worker (ISO 8601 date).
boolean
True if working full time equivalent is specified on a worker as of the effective date.
number
The new default weekly hours for the worker as of the effective date.
object
The position worker type for the worker as of the effective date.
array
The new company insider types for the worker as of the effective date.
string
The Expected Assignment End Date proposed in the business process (ISO 8601 date).
object
The workers’ compensation code override for the worker as of the effective date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_CONTRACTPartially updates the contract details for the specified job change ID. Use when modifying contract fields (end date, assignment details, pay rate, currency, purchase order, frequency) for an in-progress Workday Staffing job change. Only the initiator can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
object
The currency for the contract pay rate. Provide an instance reference (e.g. {‘id’: ‘<wid>’}).
object
The frequency for the contract pay rate.
object
The purchase order associated with the contract.
string
required
The Workday ID of the contract subresource. For singleton subresources like contract, this typically matches the job change ID.
string
The contract end date for the position as of this business process (ISO 8601 date).
object
The new contract pay rate for the contingent worker as of the effective date. Workday types this as a Currency object — pass the numeric value via the appropriate sub-field (e.g. {‘amount’: 50.25}).
string
The new contract assignment details for the contingent worker as of the effective date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_JOB_PROFILEPartially updates the jobProfile options for the specified job change ID. Use when changing the proposed job profile or job title for an in-progress Workday Staffing job change. Only the initiator can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
The new job title for the worker as of the effective date.
object
The proposed job profile for the worker. Provide an instance reference (e.g. {‘id’: ‘<job-profile-wid>’}).
string
required
The Workday ID of the jobProfile subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_LOCATIONPartially updates the location options for the specified job change ID. Use when changing workspace, work shift, location, or scheduled hours for an in-progress Workday Staffing job change. Only the initiator can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
object
The location for the worker as of the effective date.
object
The work shift for the worker as of the effective date.
object
The workspace for the worker as of the effective date. Provide an instance reference (e.g. {‘id’: ‘<wid>’}).
string
required
The Workday ID of the location subresource. For singleton subresources, this typically matches the job change ID.
number
The new scheduled hours for the worker as of the effective date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_MOVE_TEAMPartially updates the moveTeam options for the specified job change ID. Use when toggling whether the manager’s reporting teams move with them as part of an in-progress Workday Staffing job change. Only the initiator can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
boolean
Set to true to move teams reporting to the Manager with them as part of the Change Job event; false otherwise.
string
required
The Workday ID of the moveTeam subresource. For singleton subresources, this typically matches the job change ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_OPENINGPartially updates the opening options for the specified job change ID. Use when modifying headcount option or job-overlap availability for an in-progress Workday Staffing job change event. Only the initiator can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
string
The display name of the opening instance.
string
required
The Workday ID of the opening subresource. For singleton subresources, this typically matches the job change ID.
object
The headcount option for the opening. Provide an instance reference (e.g. {‘id’: ‘<wid>’}).
boolean
Set to true if the ‘Available for job overlap’ option should be enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_POSITION_OPTIONSPartially updates position options for an in-progress Workday Staffing job change, including overlap availability, closing a position, or creating a new position. Only the initiator can call this; changes must be made before the event Initiation step and submitted to persist, and a filled position cannot be closed.

Input Parameters

string
required
The Workday ID of the job change resource. This is the identifier for the job change event that was created for a worker.
object
Detailed position information. May contain id, descriptor, href, and other position-specific attributes.
string
Human-readable name or description for the position.
string
The Workday ID of the position to associate with this job change. Sent as ‘id’ in the request body.
boolean
Indicates whether the position should be closed as part of this job change. Cannot be set to true if the position is currently filled.
string
required
The Workday ID of the position subresource within the job change.
boolean
Indicates whether a new position should be created as part of this job change. Either this or a proposed position must be selected.
object
Job requisition information to associate with this position. May contain id, descriptor, and href fields.
boolean
Indicates whether the position is available for overlap with other positions. Set either this or closePosition to true, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CHANGES_START_DETAILSPartially updates the start details for the specified job change ID. Use when modifying effective date, reason, location, supervisory organization, worker, template, or job for an in-progress Workday Staffing job change. Only the initiator can call this, and changes must be submitted via POST /jobChanges/{ID}/submit. Note: the subResourceID must match the job change ID.

Input Parameters

string
required
The Workday ID of the job change resource.
object
The job associated with the job change.
string
required
The date this business process takes effect (ISO 8601 date). This field is required by the spec.
object
The reason for the job change. Provide an instance reference (e.g. {‘id’: ‘<wid>’}).
object
The worker involved in the job change.
object
The location associated with the job change.
object
The template used for the job change.
string
The display name of the instance.
string
required
The Workday ID of the startDetails subresource. For singleton subresources, this typically matches the job change ID.
boolean
Whether to use the next pay period for the change.
object
The supervisory organization for the job change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_JOB_CLASSIFICATION_OPTIONSPartially updates additional job classifications for an in-progress Workday Staffing job change. The change must be submitted to persist.

Input Parameters

string
required
The Workday ID of the job change resource. This is the identifier for the job change event that was created for a worker.
string
required
The Workday ID of the job classification subresource. For singleton subresources like jobClassification, this typically matches the job change ID.
array
List of additional job classification references to associate with the job change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_MESSAGE_TEMPLATE_BY_IDUpdates an existing message template instance. Replaces the existing instance with the specified data in the request body.

Input Parameters

string
required
The Workday ID of the message template to update.
string
required
Message Template name (required).
boolean
Indicates whether the template is active or has been disabled.
string
A preview of the instance.
object
Container for push notification data, used in REST API.
object
Email Configuration container for REST API.
string
The Reference ID to use for lookups within Workday Web Services.
object
required
Notification Type indicates where the template can be used (required).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_BUSINESS_UNITPartially updates the business unit option for the specified organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. Changes do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. The same Workday UI validations apply.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
object
The new business unit reference for the worker. Provide an instance reference (e.g., {‘id’: ‘<wid>’}). Retrieve valid business unit IDs via GET /values/organizationAssignmentChangesGroup/businessUnits/.
string
required
The Workday ID of the businessUnit subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_COMMENTPartially updates the comment for the organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. The data updates in this PATCH method don’t persist until you call POST /organizationAssignmentChanges/{ID}/submit.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
The business process comment for the worker event before it’s submitted.
string
required
The Workday ID of the comment subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_COMPANYPartially updates the company for the specified organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. Changes do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. The same Workday UI validations apply.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
object
The new company reference for the worker. Provide an instance reference (e.g., {‘id’: ‘<wid>’}). Retrieve valid company IDs via GET /values/organizationAssignmentChangesGroup/companies/.
string
required
The Workday ID of the company subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_COST_CENTERPartially updates the cost center for the specified organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. Changes do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. The same Workday UI validations apply.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
object
The new cost center reference for the worker. Provide an instance reference (e.g., {‘id’: ‘<wid>’}). Retrieve valid cost center IDs via GET /values/organizationAssignmentChangesGroup/costCenters/.
string
required
The Workday ID of the costCenter subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_REGIONPartially updates the region for the specified organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. Changes do not persist until you call POST /organizationAssignmentChanges/{ID}/submit.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
object
The new region reference for the worker. Provide an instance reference (e.g., {‘id’: ‘<wid>’}). Retrieve valid region IDs via GET /values/organizationAssignmentChangesGroup/regions/.
string
required
The Workday ID of the region subresource. Must match the ID value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_START_DETAILSPartially updates the start details for the specified organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. You can only update the date field once the event is initiated; worker, supervisoryOrganization, and position are read-only. Changes do not persist until you call POST /organizationAssignmentChanges/{ID}/submit.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
The new effective date for the event (ISO 8601 date). This is the only field that can be updated once the event is initiated.
object
Worker reference (read-only after event initiation; included for completeness).
object
Position reference (read-only after event initiation; included for completeness).
string
required
The Workday ID of the startDetails subresource. Must match the ID value.
object
Supervisory organization reference (read-only after event initiation; included for completeness).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_ORG_ASSIGN_CHANGES_CUSTOM_ORGSPartially updates the custom organizations for the specified organization assignment change ID. The {subResourceID} path parameter must equal the {ID} value. Changes do not persist until you call POST /organizationAssignmentChanges/{ID}/submit. The same Workday UI validations apply.

Input Parameters

string
required
The Workday ID of the organization assignment change resource.
string
required
The Workday ID of the customOrganizations subresource. Must match the ID value.
array
The new custom organizations for the worker. Provide a list of instance references (e.g., [{‘id’: ‘<wid>’}]). Retrieve valid custom organization IDs via GET /values/organizationAssignmentChangesGroup/customs/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_SCORECARD_RESULT_SCORESets the achievement value for the specified Score in the specified Scorecard Result on Workday’s Compensation v3 API. Use during a compensation review cycle when a manager assigns or revises a goal’s achievement percentage on an employee’s scorecard. Secured by: Set Up: Merit and Bonus.

Input Parameters

string
required
The Workday ID of the Scorecard Result whose score is being updated.
string
Optional Workday ID or Reference ID echoed in the request body. Usually omitted because the path subresourceID already identifies the score.
string
Optional display-name override for the instance. Most callers can leave this unset.
number
The achievement percentage for the scorecard criteria result. Specify a numeric value in the 1-100 range.
string
required
The Workday ID of the Score (the scorecard criteria result) within the Scorecard Result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORK_CONTACT_CHANGEUpdate the Alternate Work Location staged by this business process event. Any Home or Work address for the target Person is valid for use as an Alternate Work Location. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Work Address, Self-Service: Work Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Work Contact Change Event
string
The display name of the instance
object
The alternateWorkLocation field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORK_CONTACT_CHANGE_EMAIL_ADDRESSPartially update an existing email address that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Work Email, Self-Service: Work Email. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Email Reference
object
The usage field.
string
The display name of the instance
string
The email address.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORK_CONTACT_CHANGE_INSTANT_MESSENGERPartially update an existing instant messenger that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Work Instant Messenger, Self-Service: Work Instant Messenger. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Instant Messenger Reference
object
The type field.
object
The usage field.
string
The instant messenger account username.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORK_CONTACT_CHANGE_WEB_ADDRESSPartially update an existing web address that is staged for update by the parent business process event. Use this action when integrating Workday’s person v4 API and you need to patch this specific resource. Secured by: Person Data: Work Web Address, Self-Service: Work Web Address. Scope: Contact Information.

Input Parameters

string
required
The Workday ID of the resource.
string
The id for Web Address Reference
string
The complete URL address for the web address.
object
The usage field.
string
required
The Workday ID of the subresource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORK_CONTACT_PHONE_NUMBERPartially updates an existing phone number staged for update by the parent Work Contact Information Change business process event. Only include the fields you want to change. Note: you cannot change a primary phone to additional or vice versa, and you cannot change the Usage Type of an existing phone.

Input Parameters

string
required
The Workday ID of the Work Contact Information Change resource.
object
Usage information for the phone number.
string
Phone number extension. Not allowed when device type is VOIP.
string
Optional descriptor or display name for the phone number.
object
Reference to a phone device type.
string
required
The Workday ID of the phone number subresource to update.
object
Reference to a country phone code.
string
The complete phone number including country code and area code (e.g., ‘+1-555-123-4567’). Required unless device type is VOIP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORKER_CHECK_INPartially updates an existing Check-In instance. Equivalent to the “Edit Check-In” task in Workday. Can only be performed by the creator or participant of the Check-In. Passing archive=True calls the ?type=archive variant of the PATCH endpoint, which archives the Check-In rather than applying a normal partial update. Secured by: Self-Service: Check-Ins Scope: Performance Enablement

Input Parameters

string
required
The Workday ID of the worker, or the literal string ‘me’ to refer to the current user.
string
Updated date of the Check-In in YYYY-MM-DD format.
boolean
If True, archive the Check-In by sending ?type=archive. If False or None, perform a normal partial update with the supplied fields.
string
Updated description of the Check-In (rich text).
string
required
The Workday ID of the Check-In to update.
array
Updated list of topics included in the Check-In.
array
Updated attachments for the Check-In.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_UPDATE_WORKER_CHECK_IN_TOPICPartially updates an existing Check-In topic instance. Equivalent to the “Edit Check-In Topic” task in Workday. Can only be performed by the creator or participant of the Check-In. Passing archive=True calls the ?type=archive variant of the PATCH endpoint, which archives the topic rather than applying a normal partial update. Secured by: Self-Service: Check-Ins Scope: Performance Enablement

Input Parameters

string
required
The Workday ID of the worker, or the literal string ‘me’ to refer to the current user.
string
Updated topic name.
boolean
If True, archive the Check-In topic by sending ?type=archive. If False or None, perform a normal partial update with the supplied fields.
string
Updated shared notes of the topic (rich text).
string
Updated personal notes of the topic (rich text).
string
required
The Workday ID of the Check-In topic to update.
array
Updated list of Check-Ins associated to the topic.
array
Updated attachments for the Check-In topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKDAY_VALIDATE_PHONE_NUMBERValidates phone number data for Workday, returning the supplied number on an empty successful response and raising a validation error for a 400 response. Assumes Allowed Phone Validations are enabled for the country in Tenant Setup - Global.

Input Parameters

object
Reference to a phone device type.
object
Reference to a country phone code.
string
required
The complete phone number to validate including country code and area code (e.g., ‘+1-555-123-4567’). Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: WORKDAY_ABSENCE_BALANCE_CHANGED_TRIGGERType: pollTriggers when a worker’s absence balance changes.This trigger monitors a specific worker’s absence plan balance and detects any changes to the balance details including quantity available, effective date, position, or other related fields. Uses snapshot-based diffing to detect meaningful changes.

Configuration

string
required
The Workday ID of the absence plan to monitor (e.g., PTO, sick leave, vacation). This can be obtained from ‘List Absence Balances’ action.
string
Optional: Date for which to retrieve the balance, in yyyy-mm-dd format (e.g., ‘2025-12-31’). If omitted, monitors the most recent available balance.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The Workday ID of the worker to monitor. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’.

Payload

array
List of fields that changed (e.g., [‘quantity’, ‘effectiveDate’])
object
required
The current balance details
object
Schema for absence balance details.
number
Change in quantity (positive for increase, negative for decrease)
Slug: WORKDAY_BALANCE_DETAILS_CHANGED_TRIGGERType: pollTriggers when details of a specific balance change (quantity, accruals, adjustments, etc.).This trigger monitors a specific worker’s absence plan balance and detects any changes to the balance details including quantity available, effective date, position, or other related fields. Uses snapshot-based diffing to detect meaningful field changes.

Configuration

string
required
The Workday ID of the absence plan to monitor (e.g., PTO, sick leave, vacation). This can be obtained from ‘List Balances’ action.
string
Optional: Date for which to retrieve the balance, in yyyy-mm-dd format (e.g., ‘2025-12-31’). If omitted, monitors the most recent available balance.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The Workday ID of the worker to monitor. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’.

Payload

array
List of fields that changed (e.g., [‘quantity’, ‘effectiveDate’])
object
required
The current balance details
string
Type of event that occurred
object
Schema for balance details.
Slug: WORKDAY_INTERVIEW_FEEDBACK_SUBMITTED_TRIGGERType: pollTriggers when interview feedback is submitted or updated for a specific interview. This trigger monitors a specific interview and fires when new feedback entries are detected or existing feedback is modified.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The Workday Interview ID (WID) - a unique identifier for the interview. This can be obtained from the List Interviews action. Format: 32-character alphanumeric string.
integer
The maximum number of feedback entries to check in each poll (1-100)

Payload

string
Type of event that occurred
object
required
The feedback entry that was submitted or updated
string
required
The Workday interview ID this feedback is associated with
Slug: WORKDAY_JOB_POSTING_CHANGED_TRIGGERType: pollTriggers when a specific job posting’s details change (title, status, posting dates, location, etc.). This trigger monitors a single job posting and fires when any of its fields are modified.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique Workday ID of the job posting to monitor. This ID can be obtained from the LIST_JOB_POSTINGS or GET_MY_JOB_POSTINGS actions. Example format: ‘JOB-12345’ or a UUID-style identifier.

Payload

array
List of field names that changed between snapshots
object
required
Current state of the job posting
string
Type of event that occurred
object
Schema representing a snapshot of a job posting’s state.
Slug: WORKDAY_JOB_POSTING_QUESTIONNAIRE_CHANGED_TRIGGERType: pollTriggers when a job posting’s candidate questionnaire is added or changed.This trigger monitors a specific job posting’s questionnaires and detects any changes including additions, removals, or modifications to questionnaires and questions. Uses snapshot-based diffing to detect meaningful changes.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The Workday ID of the job posting to monitor for questionnaire changes. This ID can be obtained from the LIST_JOB_POSTINGS or GET_MY_JOB_POSTINGS actions.
array
Optional: Filter questionnaires by type (e.g., screening, pre-hire). If not specified, monitors all questionnaire types.

Payload

array
List of top-level fields that changed (e.g., ‘questionnaires’, ‘total_questions’)
object
required
The current questionnaire snapshot
string
Type of event that occurred
object
Schema representing a snapshot of questionnaires.
integer
Number of questionnaires added since last poll
integer
Number of questionnaires removed since last poll
integer
Number of questions added since last poll
integer
Number of questions removed since last poll
Slug: WORKDAY_NEW_ABSENCE_BALANCE_TRIGGERType: pollTriggers when a new absence balance record becomes available for a worker.This trigger monitors a specific worker’s absence balances and detects when new balance records appear (e.g., a new plan/bucket becomes available). Uses snapshot-based diffing to compare balance record IDs between polls.

Configuration

string
Optional: Filter by Workday ID of a specific Time Off Plan, Leave Type, or Absence Table category. Leave empty to monitor all categories.
string
Optional: Retrieve absence balances as of a specific date in yyyy-mm-dd format (e.g., ‘2024-12-31’). If not specified, uses current date.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of balance records to fetch in each poll (1-100). Default is 50.
string
required
The Workday ID of the worker to monitor for new absence balances. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’.

Payload

object
required
The newly detected absence balance record
string
Type of event that occurred
Slug: WORKDAY_NEW_INTERVIEW_SCHEDULED_TRIGGERType: pollTriggers when a new interview is scheduled/created in Workday. This trigger monitors interviews and fires when new interview records are detected.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
array
Filter interviews by status. Options: AWAITING_ME, COMPLETED, FEEDBACK_COMPLETE, NOT_SCHEDULED, PENDING_FEEDBACK, SCHEDULED, SUBMITTED_FEEDBACK, MAKE_INTERVIEW_DECISION. Leave empty to monitor all statuses.
integer
Maximum number of interviews to check in each poll (1-100)

Payload

string
Type of event that occurred
object
required
The newly scheduled interview
Slug: WORKDAY_NEW_JOB_POSTING_TRIGGERType: pollTriggers when a new job posting appears (newly published/opened) in Workday. This trigger monitors job postings and fires when new postings are detected.

Configuration

array
Filter job postings by category IDs. Leave empty to monitor all categories.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
array
Filter by specific job requisition IDs. Leave empty to monitor all job postings.
array
Filter job postings by job site IDs. Leave empty to monitor all sites.
integer
Maximum number of job postings to fetch in each poll (1-100)

Payload

string
Type of event that occurred
object
required
The newly posted job
Slug: WORKDAY_PROSPECT_PROFILE_CHANGED_TRIGGERType: pollTriggers when a specific prospect’s profile details change (contact info, status, type, source, level, tags, etc.). This trigger monitors a single prospect and fires when any of its core profile fields are modified.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique Workday ID (WID) of the prospect to monitor. Must be a 32-character hexadecimal string (e.g., ‘a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6’). This ID can be obtained from prospect-related actions.

Payload

array
List of field names that changed between snapshots
object
required
Current state of the prospect profile
string
Type of event that occurred
object
Schema representing a snapshot of a prospect’s core profile state.
Slug: WORKDAY_PROSPECT_RESUME_ATTACHMENT_ADDED_TRIGGERType: pollTriggers when a new resume/attachment is added to a specific prospect profile. This trigger monitors a prospect’s resume attachments and fires when new attachments are detected.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of attachments to check in each poll (1-100)
string
required
The Workday ID of the prospect to monitor for new resume attachments

Payload

object
required
The newly added resume attachment
string
Type of event that occurred
string
required
The prospect ID this attachment belongs to
Slug: WORKDAY_WORKER_ELIGIBLE_ABSENCE_TYPE_CHANGED_TRIGGERType: pollTriggers when a worker becomes eligible or ineligible for an absence type.This trigger monitors the list of eligible absence types for a specific worker and detects when new absence types are added (worker becomes eligible) or when absence types are removed (worker becomes ineligible). Uses snapshot-based diffing to compare the list of absence type IDs between polls.Note: Due to Workday security permissions, this endpoint typically only allows access to the authenticated user’s own data.

Configuration

string
Optional: Filter by absence type category. Valid values: Leave of Absence Type (17bd6531c90c100016d74f8dfae007d0), Absence Table (17bd6531c90c100016da3f5b554007d2), Time Off (17bd6531c90c100016d4b06f2b8a07ce).
string
Optional: The effective date for which to check eligible absence types, in yyyy-mm-dd format (e.g., ‘2025-12-31’). If omitted, uses current date.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The Workday ID of the worker to monitor. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’. Note: Due to Workday security permissions, this typically only works for the authenticated user’s own worker ID.

Payload

array
List of absence types that the worker became newly eligible for
string
Type of event that occurred
array
List of absence types that the worker is no longer eligible for
Slug: WORKDAY_WORKER_LEAVE_OF_ABSENCE_CHANGED_TRIGGERType: pollTriggers when a worker’s leave of absence record changes.This trigger monitors all leaves of absence for a specific worker and detects:
  • New leave requests created
  • Changes to existing leaves (status, dates, comments, etc.)
  • Deleted or rescinded leaves
Uses snapshot-based diffing to track changes between polling intervals.

Configuration

string
Optional: Start date for filtering leaves in yyyy-mm-dd format.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
array
Optional: Filter by specific leave type IDs. Multiple IDs can be specified to monitor multiple types.
array
Optional: Filter by specific status IDs. Use ‘Get Leave Status Values’ action to retrieve valid status IDs.
string
Optional: End date for filtering leaves in yyyy-mm-dd format.
string
required
The Workday ID of the worker to monitor. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’.

Payload

string
required
Type of change: ‘created’, ‘updated’, or ‘deleted’
array
List of fields that changed for updated records (e.g., [‘status’, ‘estimatedLastDayOfLeave’])
object
Schema for leave of absence details.
string
required
The unique ID of the leave of absence record that changed
object
Schema for leave of absence details.
Slug: WORKDAY_WORKER_LEAVE_OF_ABSENCE_CREATED_TRIGGERType: pollTriggers when a new leave of absence record is created for a worker.This trigger monitors a specific worker’s leaves of absence and detects when new leave records appear (e.g., when a leave is initiated/recorded). Uses snapshot-based diffing to compare leave record IDs between polls.

Configuration

string
Optional: Only monitor leaves starting from this date onwards (yyyy-mm-dd format). Useful for filtering historical leaves.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
array
Optional: Filter by specific leave type IDs (UUIDs). You can specify multiple leave type IDs to monitor specific types of leaves (e.g., Personal Leave, Medical Leave, etc.). Leave empty to monitor all leave types.
integer
Maximum number of leave records to fetch in each poll (1-100). Default is 50.
array
Optional: Filter by leave status IDs (UUIDs). Use the ‘Get Leave Status Values’ action to retrieve valid status IDs. Common statuses include: Successfully Completed, In Progress, Canceled, Rescinded. Leave empty to monitor all statuses.
string
required
The Workday ID of the worker to monitor for new leave of absence records. This can be obtained from actions like ‘Get Current User’ or ‘List Workers’.

Payload

string
Type of event that occurred
object
required
The newly created leave of absence record