> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Workday

> Workday is a cloud-based enterprise resource planning (ERP) software that provides comprehensive solutions for human capital management, financial management, and analytics

![Workday logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/workday.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=f167911814bfc5fdab5c66777d9a926c)

* **Category:** human resources
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 588
* **Triggers:** 13
* **Slug:** `WORKDAY`
* **Version:** 20261101\_00

## Tools

> [accordion] Approve Business Process Event Step
>
> **Slug:** `WORKDAY_APPROVE_BUSINESS_PROCESS_EVENT_STEP`
>
> Approves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event step to approve.
>
> **comment** `string` *required*
>
> Approval comment recorded on the event step. Workday requires a comment for this endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Import Update Employee Review Rating
>
> **Slug:** `WORKDAY_BULK_IMPORT_UPDATE_EMPLOYEE_REVIEW_RATING`
>
> Bulk-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
>
> **update\_employee\_review\_rating\_requests** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Business Process Event
>
> **Slug:** `WORKDAY_CANCEL_BUSINESS_PROCESS_EVENT`
>
> Cancels 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event to cancel.
>
> **comment** `string`
>
> Optional reason recorded on the event for the cancellation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace Benefit Elections for Life Event
>
> **Slug:** `WORKDAY_CHANGE_BENEFITS`
>
> Replace 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
>
> **comment** `string`
>
> Optional business-process comment.
>
> **run\_now** `boolean`
>
> Process the business process before returning the response.
>
> **event\_date** `string` *required*
>
> Date of the qualifying life event.
>
> **auto\_complete** `boolean`
>
> Automatically approve and bypass all business-process steps and notifications.
>
> **benefit\_elections** `array`
>
> Complete direct Benefit\_Election\_Data set for the event type. Include every applicable plan because Workday does not preserve omissions or apply defaults.
>
> **employee\_reference** `object` *required*
>
> Employee whose complete benefit election set will be replaced.
>
> **employee\_tobacco\_use** `array`
>
> Required employee tobacco-use responses.
>
> **excess\_credits\_to\_hsa** `string`
>
> Excess benefit package credits directed to an HSA.
>
> **original\_signature\_date** `string`
>
> Original signature date for migrated enrollment data.
>
> **signing\_worker\_reference** `object`
>
> Worker who signed the enrollment event.
>
> **spouse\_or\_dp\_tobacco\_use** `array`
>
> Required spouse or domestic partner tobacco-use responses.
>
> **enrollment\_signature\_date** `string`
>
> Date the enrollment event was signed.
>
> **benefit\_event\_type\_reference** `object` *required*
>
> The single qualifying event type controlling available benefit plans.
>
> **confirm\_complete\_election\_set** `boolean` *required*
>
> Required acknowledgement that all applicable direct and grouped retirement elections for the event type are included.
>
> **has\_existing\_medical\_coverage** `boolean`
>
> Whether a medical waiver is backed by outside coverage.
>
> **worker\_other\_health\_insurance** `array`
>
> Other health care insurance records for the worker.
>
> **dependent\_other\_health\_insurance** `array`
>
> Other health care insurance records grouped by dependent.
>
> **discard\_on\_exit\_validation\_error** `boolean`
>
> Do not create an event when a critical exit validation fails.
>
> **retirement\_savings\_coverage\_types** `array`
>
> Complete grouped retirement elections and coverage-level contributions.
>
> **benefit\_deduction\_periods\_remaining** `integer`
>
> Remaining payroll deduction periods.
>
> **remaining\_period\_frequency\_reference** `object`
>
> Benefit deduction frequency for remaining periods.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change Worker Marital Status
>
> **Slug:** `WORKDAY_CHANGE_WORKER_MARITAL_STATUS`
>
> Change 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
>
> **person\_id** `string` *required*
>
> Workday worker identifier whose marital status will change.
>
> **country\_id** `string`
>
> Optional country context for the personal-information change. If omitted, Workday uses the person's primary-position location.
>
> **person\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Official Workday RoleObject identifier type used for person\_id.
>
> **country\_id\_type** `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.
>
> **marital\_status\_id** `string` *required*
>
> Active tenant marital-status identifier to assign to the person.
>
> **marital\_status\_date** `string`
>
> Optional date on which the new marital status took effect.
>
> **marital\_status\_id\_type** `string ("WID" | "Marital_Status_Code" | "Marital_Status_ID")`
>
> Official Workday Marital\_StatusObject identifier type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change Worker Military Service
>
> **Slug:** `WORKDAY_CHANGE_WORKER_MILITARY_SERVICE`
>
> Add 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
>
> **notes** `string`
>
> Optional military service notes accepted by Workday's RichText field.
>
> **person\_id** `string` *required*
>
> Workday worker identifier whose military service entry will change.
>
> **country\_id** `string`
>
> Optional country context for military-information localization. If omitted, Workday derives location context from the person's primary position.
>
> **person\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Official Workday RoleObject identifier type used for person\_id.
>
> **country\_id\_type** `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.
>
> **military\_rank\_id** `string`
>
> Optional military rank valid for the service type and status country.
>
> **military\_status\_id** `string` *required*
>
> Active tenant military-status identifier valid for the worker's country context.
>
> **military\_service\_id** `string`
>
> Existing military service entry identifier to update. Omit only when adding one new entry; this action never deletes entries.
>
> **military\_rank\_id\_type** `string ("WID" | "Military_Rank_ID")`
>
> Official Workday Military\_RankObject identifier type.
>
> **military\_discharge\_date** `string`
>
> Optional date on which the person was discharged from military service.
>
> **military\_status\_id\_type** `string ("WID" | "Armed_Forces_Status_ID" | "Military_Status_ID")`
>
> Official Workday Military\_StatusObject identifier type.
>
> **military\_service\_id\_type** `string ("WID" | "Military_Service_ID")`
>
> Official Workday Military\_Service\_ReferenceObject identifier type used when military\_service\_id is set.
>
> **military\_service\_type\_id** `string`
>
> Optional active military service type valid for the status country.
>
> **military\_discharge\_type\_id** `string`
>
> Optional active military discharge type valid for the status country.
>
> **military\_status\_begin\_date** `string`
>
> Optional date on which the military status began.
>
> **military\_service\_type\_id\_type** `string ("WID" | "Military_Service_Type_ID")`
>
> Official Workday Military\_Service\_TypeObject identifier type.
>
> **military\_discharge\_type\_id\_type** `string ("WID" | "Military_Discharge_Type_ID")`
>
> Official Workday Military\_Discharge\_TypeObject identifier type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Close Request
>
> **Slug:** `WORKDAY_CLOSE_REQUEST`
>
> Closes 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
>
> **ID** `string` *required*
>
> The Workday ID of the request to close.
>
> **comment** `string`
>
> Latest comment for the request event.
>
> **requestID** `string`
>
> Request ID (per the ID generator format).
>
> **resolution** `object` *required*
>
> The Workday ID of the resolution to apply. Required field. Valid values: 00000000000000000000000000000104 (Done), 00000000000000000000000000000108 (Duplicate), 00000000000000000000000000000109 (Denied), 00000000000000000000000000000107 (Canceled).
>
> **requestSubtype** `object`
>
> A reference to a Workday instance (id only required).
>
> **resolutionDetails** `object`
>
> A reference to a Workday instance (id only required).
>
> **workdayObjectValue** `object`
>
> A reference to a Workday instance (id only required).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Business Title Change
>
> **Slug:** `WORKDAY_CREATE_BUSINESS_TITLE_CHANGE`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource for whom to create the business title change.
>
> **proposedBusinessTitle** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Case
>
> **Slug:** `WORKDAY_CREATE_CASE`
>
> Create 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
>
> **title** `string` *required*
>
> Case title, up to 140 characters.
>
> **source** `object`
>
> Valid Help case source.
>
> **caseType** `object` *required*
>
> Case type available to the case owner.
>
> **forWorker** `object`
>
> Worker who will own the case.
>
> **aboutWorker** `object`
>
> Different worker whom the case concerns.
>
> **attachments** `array`
>
> Previously uploaded Help attachment references.
>
> **detailedMessage** `string`
>
> Detailed case description.
>
> **forExternalCreator** `object`
>
> External creator who will own the case.
>
> **questionnaireHolder** `object`
>
> Case questionnaire response holder associated with the selected case type.
>
> **questionnaireResponses** `object`
>
> Typed answers for the selected case type's questionnaire.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Compensation Scorecard
>
> **Slug:** `WORKDAY_CREATE_COMPENSATION_SCORECARD`
>
> Creates 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
>
> **id** `string`
>
> Optional Workday ID or Reference ID for the new scorecard; usually omitted so Workday generates one.
>
> **inactive** `boolean`
>
> True marks the new scorecard as inactive. Defaults to false in Workday when omitted.
>
> **effectiveDate** `string` *required*
>
> The Effective Date of the Compensation Scorecard in YYYY-MM-DD format.
>
> **scorecardName** `string` *required*
>
> The name of the Compensation Scorecard.
>
> **scorecardProfiles** `array`
>
> Optional profile-specific sections. Each profile requires an eligibilityRule.id and at least one entry in profileScorecardGoals.
>
> **scorecardDescription** `string`
>
> Free-text description of the Compensation Scorecard.
>
> **defaultScorecardGoals** `array` *required*
>
> The default goals for the Compensation Scorecard. Each goal must specify goalName and goalWeight.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Field Type
>
> **Slug:** `WORKDAY_CREATE_CUSTOM_FIELD_TYPE`
>
> Creates 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
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Field Type List Value
>
> **Slug:** `WORKDAY_CREATE_CUSTOM_FIELD_TYPE_LIST_VALUE`
>
> Adds 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom field type (custom list) that the new list value belongs to.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Object
>
> **Slug:** `WORKDAY_CREATE_CUSTOM_OBJECT`
>
> Creates (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
>
> **bulk** `boolean`
>
> If true, accepts an array of custom object instances in the request body. Defaults to false.
>
> **updateIfExists** `boolean`
>
> If true, updates the custom object instance if it exists. Defaults to false.
>
> **customObjectData** `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.
>
> **customObjectAlias** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Object Definition Condition Rule
>
> **Slug:** `WORKDAY_CREATE_CUSTOM_OBJECT_DEFINITION_CONDITION_RULE`
>
> Adds 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that the condition rule belongs to.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Object Definition Field
>
> **Slug:** `WORKDAY_CREATE_CUSTOM_OBJECT_DEFINITION_FIELD`
>
> Adds 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that the new field belongs to.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Object Definition Validation
>
> **Slug:** `WORKDAY_CREATE_CUSTOM_OBJECT_DEFINITION_VALIDATION`
>
> Adds 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that the validation belongs to.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Expense Entry
>
> **Slug:** `WORKDAY_CREATE_EXPENSE_ENTRY`
>
> Creates 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
>
> **date** `string` *required*
>
> Transaction date for the expense entry (YYYY-MM-DD).
>
> **memo** `string`
>
> Free-form memo to attach to the expense entry.
>
> **amount** `object`
>
> Amount for the expense entry (Workday Currency object — typically `{"value": <amount>, "currency": {"id": <WID>}}`).
>
> **merchant** `string`
>
> Name of the merchant for the expense entry.
>
> **scanStatus** `object`
>
> A Workday instance reference (id / descriptor / href).
>
> **attachments** `array`
>
> Optional list of attachments (e.g. receipt images) to associate with the new entry.
>
> **expenseItem** `object` *required*
>
> Reference to the expense item (category) this Quick Expense charges to.
>
> **hasOCRReceipt** `boolean`
>
> Whether the entry should be flagged as having an OCR-scanned receipt image.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Expense Entry Attachment
>
> **Slug:** `WORKDAY_CREATE_EXPENSE_ENTRY_ATTACHMENT`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the expense entry the attachment is being added to.
>
> **fileName** `string`
>
> File name of the attachment (e.g. 'receipt-2026-05-23.jpg').
>
> **fileLength** `integer`
>
> File length of the attachment in bytes.
>
> **contentType** `object`
>
> MIME content-type reference for an attachment.
>
> **attachmentContent** `string`
>
> Base64-encoded attachment content (RaaS / Reports as Web Services form).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Expense Report
>
> **Slug:** `WORKDAY_CREATE_EXPENSE_REPORT`
>
> Creates 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
>
> **payee** `object` *required*
>
> Worker who will be reimbursed by this expense report.
>
> **company** `object`
>
> Company reference for the expense report.
>
> **worktag** `object`
>
> Worktag reference (cost center, project, etc.) for the expense report.
>
> **creationDate** `string`
>
> Creation date of the expense report (YYYY-MM-DD). Defaults to today when omitted.
>
> **expenseReportMemo** `string`
>
> Free-form memo / label for the expense report.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Expense Report Line
>
> **Slug:** `WORKDAY_CREATE_EXPENSE_REPORT_LINE`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the expense report to add the line to.
>
> **date** `string`
>
> Date the expense report line was created (YYYY-MM-DD).
>
> **memo** `string`
>
> Free-form memo for the expense report line.
>
> **expenseItem** `object`
>
> Expense item (category) reference for a report line.
>
> **totalAmount** `object`
>
> Total amount to be reimbursed for this line (Workday Currency object — typically `{"value": <amount>, "currency": {"id": <WID>}}`).
>
> **quickExpense** `object`
>
> Reference to an existing Quick Expense entry that backs this line.
>
> **travelBookingRecord** `object`
>
> Reference to a travel booking record that backs this line.
>
> **creditCardTransaction** `object`
>
> Reference to an existing credit card transaction that backs this line.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Home Contact Change Address
>
> **Slug:** `WORKDAY_CREATE_HOME_CONTACT_CHANGE_ADDRESS`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Address Reference
>
> **city** `string`
>
> City
>
> **usage** `object`
>
> The usage field.
>
> **country** `object`
>
> The country field.
>
> **cityLocal** `string`
>
> City - Local
>
> **postalCode** `string`
>
> Postal Code
>
> **countryCity** `object`
>
> The countryCity field.
>
> **addressLine1** `string`
>
> Address Line 1
>
> **addressLine2** `string`
>
> Address Line 2
>
> **addressLine3** `string`
>
> Address Line 3
>
> **addressLine4** `string`
>
> Address Line 4
>
> **addressLine5** `string`
>
> Address Line 5
>
> **addressLine6** `string`
>
> Address Line 6
>
> **addressLine7** `string`
>
> Address Line 7
>
> **addressLine8** `string`
>
> Address Line 8
>
> **addressLine9** `string`
>
> Address Line 9
>
> **countryRegion** `object`
>
> The countryRegion field.
>
> **numberDaysWFH** `integer`
>
> Number of Days WFH
>
> **citySubdivision1** `string`
>
> City Subdivision 1
>
> **citySubdivision2** `string`
>
> City Subdivision 2
>
> **addressLine1Local** `string`
>
> Local Address Line 1
>
> **addressLine2Local** `string`
>
> Local Address Line 2
>
> **addressLine3Local** `string`
>
> Local Address Line 3
>
> **addressLine4Local** `string`
>
> Local Address Line 4
>
> **addressLine5Local** `string`
>
> Local Address Line 5
>
> **addressLine6Local** `string`
>
> Local Address Line 6
>
> **addressLine7Local** `string`
>
> Local Address Line 7
>
> **addressLine8Local** `string`
>
> Local Address Line 8
>
> **addressLine9Local** `string`
>
> Local Address Line 9
>
> **regionSubdivision1** `string`
>
> Region Subdivision 1
>
> **regionSubdivision2** `string`
>
> Region Subdivision 2
>
> **citySubdivision1Local** `string`
>
> City Subdivision 1 - Local
>
> **citySubdivision2Local** `string`
>
> City Subdivision 2 - Local
>
> **regionSubdivision1Local** `string`
>
> Region Subdivision 1 - Local
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Home Contact Change Email Address
>
> **Slug:** `WORKDAY_CREATE_HOME_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Email Reference
>
> **usage** `object`
>
> The usage field.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **emailAddress** `string`
>
> The email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Home Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_CREATE_HOME_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Instant Messenger Reference
>
> **type** `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.'
>
> **usage** `object`
>
> The usage field.
>
> **userName** `string`
>
> The instant messenger account username.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Home Contact Change Phone Number
>
> **Slug:** `WORKDAY_CREATE_HOME_CONTACT_CHANGE_PHONE_NUMBER`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Phone Reference
>
> **usage** `object`
>
> The usage field.
>
> **extension** `string`
>
> The phone extension.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **deviceType** `object`
>
> The deviceType field.
>
> **countryPhoneCode** `object`
>
> The countryPhoneCode field.
>
> **completePhoneNumber** `string`
>
> The complete phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Home Contact Change Web Address
>
> **Slug:** `WORKDAY_CREATE_HOME_CONTACT_CHANGE_WEB_ADDRESS`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Web Address Reference
>
> **url** `string`
>
> The complete URL address for the web address.
>
> **usage** `object`
>
> The usage field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job Change for Worker
>
> **Slug:** `WORKDAY_CREATE_JOB_CHANGE_WORKER`
>
> Initiates 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker for whom to create the job change.
>
> **job** `object`
>
> Job reference object for assigning a specific job to the worker.
>
> **date** `string` *required*
>
> Effective date of the job change in YYYY-MM-DD format. Must be a valid date for the job change operation.
>
> **reason** `object`
>
> Job change reason reference object with id property. Must be a valid job change reason ID.
>
> **location** `object`
>
> Location reference object for assigning a work location.
>
> **template** `object`
>
> Template reference object with id property for pre-populating job change fields.
>
> **descriptor** `string`
>
> Optional descriptor or label for the job change instance.
>
> **supervisoryOrganization** `object`
>
> Supervisory organization reference object with id property. Must be active on the effective date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Mentorship For Me
>
> **Slug:** `WORKDAY_CREATE_MENTORSHIP_FOR_ME`
>
> Creates 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
>
> **mentor** `object` *required*
>
> The mentor worker reference. Required.
>
> **comment** `string`
>
> Comment for the event record.
>
> **endDate** `string`
>
> Proposed end date for the mentorship (YYYY-MM-DD).
>
> **purpose** `string`
>
> Proposed purpose for the mentorship (rich text).
>
> **startDate** `string` *required*
>
> Proposed start date for the mentorship (YYYY-MM-DD). Required.
>
> **mentorType** `object` *required*
>
> The mentor type reference. Required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Mentorship For Worker
>
> **Slug:** `WORKDAY_CREATE_MENTORSHIP_FOR_WORKER`
>
> Creates 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
>
> **mentee** `object` *required*
>
> The mentee worker reference. Required.
>
> **mentor** `object` *required*
>
> The mentor worker reference. Required.
>
> **comment** `string`
>
> Comment for the event record.
>
> **endDate** `string`
>
> Proposed end date for the mentorship (YYYY-MM-DD).
>
> **purpose** `string`
>
> Proposed purpose for the mentorship (rich text).
>
> **startDate** `string` *required*
>
> Proposed start date for the mentorship (YYYY-MM-DD). Required.
>
> **mentorType** `object` *required*
>
> The mentor type reference. Required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Message Template
>
> **Slug:** `WORKDAY_CREATE_MESSAGE_TEMPLATE`
>
> Creates 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
>
> **name** `string` *required*
>
> Message Template name (required).
>
> **inactive** `boolean`
>
> Indicates whether the template is active or has been disabled.
>
> **descriptor** `string`
>
> A preview of the instance.
>
> **pushDetail** `object`
>
> Container for push notification data, used in REST API.
>
> **emailDetail** `object`
>
> Email Configuration container for REST API.
>
> **referenceID** `string`
>
> The Reference ID to use for lookups within Workday Web Services.
>
> **notificationType** `object` *required*
>
> Notification Type indicates where the template can be used (required).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Organization Assignment Change
>
> **Slug:** `WORKDAY_CREATE_ORGANIZATION_ASSIGNMENT_CHANGE`
>
> Creates 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
>
> **date** `string` *required*
>
> The effective date of the business process event in YYYY-MM-DD format. Required.
>
> **position** `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.
>
> **descriptor** `string`
>
> Optional display name of the instance.
>
> **massActionHeader** `object`
>
> Optional mass-action header reference object (e.g., \{'id': '\<wid>'}).
>
> **massActionWorksheet** `object`
>
> Optional mass-action worksheet reference object (e.g., \{'id': '\<wid>'}).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Organization Goal
>
> **Slug:** `WORKDAY_CREATE_ORGANIZATION_GOAL`
>
> Creates 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
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payroll Inputs
>
> **Slug:** `WORKDAY_CREATE_PAYROLL_INPUTS`
>
> Creates 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
>
> **worker** `object` *required*
>
> The worker for whom the payroll input is being created.
>
> **comment** `string`
>
> Comment for the payroll input.
>
> **endDate** `string`
>
> The end date for the payroll input, using the date format yyyy-mm-dd. Required for one-time payroll inputs.
>
> **ongoing** `boolean`
>
> Whether the payroll input is ongoing (recurring) or one-time.
>
> **currency** `object`
>
> Reference to a currency in Workday
>
> **position** `object`
>
> Reference to a position in Workday
>
> **worktags** `array`
>
> List of worktags for the payroll input.
>
> **startDate** `string` *required*
>
> The start date for the payroll input, using the date format yyyy-mm-dd.
>
> **adjustment** `boolean`
>
> Whether this is an adjustment to an existing payroll input.
>
> **inputDetails** `array` *required*
>
> List of input details for the payroll input.
>
> **payComponent** `object` *required*
>
> The pay component for the payroll input.
>
> **runCategories** `array`
>
> List of run categories for the payroll input.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prospect
>
> **Slug:** `WORKDAY_CREATE_PROSPECT`
>
> Create 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
>
> **type** `object`
>
> Configured prospect type reference.
>
> **level** `object`
>
> Target management level reference.
>
> **source** `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.
>
> **status** `object`
>
> Configured prospect status reference.
>
> **candidate** `object` *required*
>
> Candidate name and contact details required to create the prospect.
>
> **referredBy** `object`
>
> Worker reference for the person who referred the candidate.
>
> **candidateTags** `array`
>
> Active candidate tag references.
>
> **candidatePools** `array`
>
> Active static candidate pool references.
>
> **contactConsent** `boolean`
>
> Whether the candidate agrees to be contacted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prospect Education
>
> **Slug:** `WORKDAY_CREATE_PROSPECT_EDUCATION`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the prospect to attach the education entry to.
>
> **degree** `object`
>
> The degree instance reference obtained by the candidate (e.g., \{'id': '\<degree-wid>'}).
>
> **schoolName** `string`
>
> The name of the school the candidate attended or is attending. Required by Workday.
>
> **fieldOfStudy** `object`
>
> The field of study instance reference (e.g., \{'id': '\<field-of-study-wid>'}).
>
> **gradeAverage** `string`
>
> The candidate's grade average at this educational institution.
>
> **lastYearAttended** `string`
>
> The last year the candidate attended this educational institution.
>
> **firstYearAttended** `string`
>
> The first year the candidate attended this educational institution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prospect Experience
>
> **Slug:** `WORKDAY_CREATE_PROSPECT_EXPERIENCE`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the prospect to attach the work experience entry to.
>
> **title** `string`
>
> The business title for the candidate's work experience. Required by Workday.
>
> **endYear** `string`
>
> The year the candidate ended employment at this company.
>
> **endMonth** `integer`
>
> The month (1-12) the candidate ended employment at this company.
>
> **location** `string`
>
> The location of this company.
>
> **startYear** `string`
>
> The year the candidate started employment at this company. Required by Workday.
>
> **startMonth** `integer`
>
> The month (1-12) the candidate started employment at this company.
>
> **companyName** `string`
>
> The company name the candidate entered in their job history. Required by Workday.
>
> **description** `string`
>
> Any responsibilities or accomplishments the candidate gained at the associated company.
>
> **currentlyWorkHere** `boolean`
>
> If true, the candidate currently works at this company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prospect Skill
>
> **Slug:** `WORKDAY_CREATE_PROSPECT_SKILL`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the prospect to attach the skill to.
>
> **name** `string`
>
> The name of the candidate skill. Required by Workday.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Reference Letter for Worker
>
> **Slug:** `WORKDAY_CREATE_REFERENCE_LETTER_FOR_WORKER`
>
> Initiate 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
>
> **worker\_id** `string` *required*
>
> Workday identifier for the worker receiving the letter.
>
> **language\_id** `string`
>
> Optional Workday document language identifier for the generated letter.
>
> **template\_id** `string` *required*
>
> Tenant-defined reference-letter template identifier. The template must be active and available to the caller; it is never inferred or hardcoded.
>
> **worker\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Official Workday WorkerObject identifier type used for worker\_id.
>
> **language\_id\_type** `string ("WID" | "User_Language_ID")`
>
> Official Workday User\_LanguageObject identifier type.
>
> **template\_id\_type** `string ("WID" | "Reference_Letter_Template_ID")`
>
> Official Workday Reference\_Letter\_TemplateObject identifier type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Request
>
> **Slug:** `WORKDAY_CREATE_REQUEST`
>
> Creates 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
>
> **comment** `string`
>
> Latest comment for the request event.
>
> **requestID** `string`
>
> Request ID (per the ID generator format).
>
> **onBehalfOf** `object`
>
> A reference to a Workday instance (id only required).
>
> **description** `string`
>
> Description of the request.
>
> **requestType** `object` *required*
>
> Type of the request (Workday ID from GET /types).
>
> **questionnaireResponses** `object`
>
> Questionnaire response submission payload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Scorecard Result
>
> **Slug:** `WORKDAY_CREATE_SCORECARD_RESULT`
>
> Creates 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
>
> **id** `string`
>
> Optional Workday ID or Reference ID to assign to the new Scoreset Container; usually omitted so Workday generates one.
>
> **descriptor** `string`
>
> Optional display-name override for the new Scorecard Result instance.
>
> **scorecardID** `object` *required*
>
> Reference to the Compensation Scorecard being evaluated. The id field must be set.
>
> **evaluationDate** `string` *required*
>
> The date when the Scorecard Result is evaluated. Use the yyyy-mm-dd format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Succession Plan
>
> **Slug:** `WORKDAY_CREATE_SUCCESSION_PLAN`
>
> Creates 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
>
> **position** `object` *required*
>
> The position associated with the succession plan. Required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Tax Rate
>
> **Slug:** `WORKDAY_CREATE_TAX_RATE`
>
> Creates 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
>
> **ein** `string`
>
> The payroll tax authority EIN (Employer Identification Number) for company tax reporting.
>
> **exempt** `boolean`
>
> If true, the SUI rate is exempt.
>
> **endDate** `string`
>
> The end date for company tax reporting, in yyyy-mm-dd format.
>
> **taxCode** `string` *required*
>
> The deduction code used for company tax reporting (e.g. the SUI tax code).
>
> **startDate** `string` *required*
>
> The start date for company tax reporting, in yyyy-mm-dd format.
>
> **stateInstance** `object` *required*
>
> The payroll state authority the SUI rate applies to.
>
> **applicableRate** `string`
>
> The tax override rate for company tax reporting, expressed as a decimal string (e.g. '0.027').
>
> **companyInstance** `object` *required*
>
> The company the SUI rate applies to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Time Clock Event
>
> **Slug:** `WORKDAY_CREATE_TIME_CLOCK_EVENT`
>
> Create 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
>
> **fund** `object`
>
> A writable Workday instance reference.
>
> **gift** `object`
>
> A writable Workday instance reference.
>
> **grant** `object`
>
> A writable Workday instance reference.
>
> **region** `object`
>
> A writable Workday instance reference.
>
> **worker** `object` *required*
>
> Worker for the time clock event.
>
> **comment** `string`
>
> Comment on the event.
>
> **program** `object`
>
> A writable Workday instance reference.
>
> **project** `object`
>
> Project reference.
>
> **currency** `object`
>
> A writable Workday instance reference.
>
> **dateTime** `string` *required*
>
> Event local date and time in ISO 8601 format.
>
> **location** `object`
>
> A writable Workday instance reference.
>
> **position** `object`
>
> A writable Workday instance reference.
>
> **timeZone** `object` *required*
>
> Time zone for dateTime. Use LIST\_TIME\_CLOCK\_OPTIONS to get eligible IDs.
>
> **eventType** `object` *required*
>
> Official event type for the punch. Use LIST\_TIME\_CLOCK\_OPTIONS to get IDs.
>
> **costCenter** `object`
>
> A writable Workday instance reference.
>
> **jobProfile** `object`
>
> A writable Workday instance reference.
>
> **businessUnit** `object`
>
> A writable Workday instance reference.
>
> **overrideRate** `number`
>
> Override rate for the event.
>
> **appropriation** `object`
>
> A writable Workday instance reference.
>
> **timeEntryCode** `object`
>
> Time entry code reference.
>
> **allocationPool** `object`
>
> A writable Workday instance reference.
>
> **projectPlanTask** `object`
>
> Project plan task reference.
>
> **additionalWorktags** `object`
>
> Additional references keyed by customOrganization01..10 or customWorktag01..15.
>
> **workerTimeAttestations** `array`
>
> Optional ID-only references to existing worker time attestations required by the worker's Time Tracking configuration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Time Off Request
>
> **Slug:** `WORKDAY_CREATE_TIME_OFF_REQUEST`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **days** `array` *required*
>
> List of time off entries for the request.
>
> **timeOffRequestEventView** `string`
>
> View name for the time off request event. Leave empty for default view.
>
> **businessProcessParameters** `object` *required*
>
> Business process parameters for the time off request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Work Contact Change Address
>
> **Slug:** `WORKDAY_CREATE_WORK_CONTACT_CHANGE_ADDRESS`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Address Reference
>
> **city** `string`
>
> City
>
> **usage** `object`
>
> The usage field.
>
> **country** `object`
>
> The country field.
>
> **cityLocal** `string`
>
> City - Local
>
> **postalCode** `string`
>
> Postal Code
>
> **countryCity** `object`
>
> The countryCity field.
>
> **addressLine1** `string`
>
> Address Line 1
>
> **addressLine2** `string`
>
> Address Line 2
>
> **addressLine3** `string`
>
> Address Line 3
>
> **addressLine4** `string`
>
> Address Line 4
>
> **addressLine5** `string`
>
> Address Line 5
>
> **addressLine6** `string`
>
> Address Line 6
>
> **addressLine7** `string`
>
> Address Line 7
>
> **addressLine8** `string`
>
> Address Line 8
>
> **addressLine9** `string`
>
> Address Line 9
>
> **countryRegion** `object`
>
> The countryRegion field.
>
> **citySubdivision1** `string`
>
> City Subdivision 1
>
> **citySubdivision2** `string`
>
> City Subdivision 2
>
> **addressLine1Local** `string`
>
> Local Address Line 1
>
> **addressLine2Local** `string`
>
> Local Address Line 2
>
> **addressLine3Local** `string`
>
> Local Address Line 3
>
> **addressLine4Local** `string`
>
> Local Address Line 4
>
> **addressLine5Local** `string`
>
> Local Address Line 5
>
> **addressLine6Local** `string`
>
> Local Address Line 6
>
> **addressLine7Local** `string`
>
> Local Address Line 7
>
> **addressLine8Local** `string`
>
> Local Address Line 8
>
> **addressLine9Local** `string`
>
> Local Address Line 9
>
> **regionSubdivision1** `string`
>
> Region Subdivision 1
>
> **regionSubdivision2** `string`
>
> Region Subdivision 2
>
> **citySubdivision1Local** `string`
>
> City Subdivision 1 - Local
>
> **citySubdivision2Local** `string`
>
> City Subdivision 2 - Local
>
> **regionSubdivision1Local** `string`
>
> Region Subdivision 1 - Local
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Work Contact Change Email Address
>
> **Slug:** `WORKDAY_CREATE_WORK_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Email Reference
>
> **usage** `object`
>
> The usage field.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **emailAddress** `string`
>
> The email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Work Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_CREATE_WORK_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Instant Messenger Reference
>
> **type** `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.'
>
> **usage** `object`
>
> The usage field.
>
> **userName** `string`
>
> The instant messenger account username.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Work Contact Change Phone Number
>
> **Slug:** `WORKDAY_CREATE_WORK_CONTACT_CHANGE_PHONE_NUMBER`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Phone Reference
>
> **usage** `object`
>
> The usage field.
>
> **extension** `string`
>
> The phone extension.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **deviceType** `object`
>
> The deviceType field.
>
> **countryPhoneCode** `object`
>
> The countryPhoneCode field.
>
> **completePhoneNumber** `string`
>
> The complete phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Work Contact Change Web Address
>
> **Slug:** `WORKDAY_CREATE_WORK_CONTACT_CHANGE_WEB_ADDRESS`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Web Address Reference
>
> **url** `string`
>
> The complete URL address for the web address.
>
> **usage** `object`
>
> The usage field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Anytime Feedback Event
>
> **Slug:** `WORKDAY_CREATE_WORKER_ANYTIME_FEEDBACK_EVENT`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Explicit Skills
>
> **Slug:** `WORKDAY_CREATE_WORKER_EXPLICIT_SKILLS`
>
> Saves the skills a worker has, creating explicit-skill usage instances. Secured by: Self-Service: Skills Scope: Worker Profile and Skills
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **skills** `array`
>
> Explicit skill usages to save for the worker.
>
> **skillItem** `object`
>
> Skill item reference (with id) the user is asserting they have.
>
> **skillSources** `array`
>
> Skill sources that serve as evidence for the skill usage.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Requested Feedback On Self Event
>
> **Slug:** `WORKDAY_CREATE_WORKER_REQUESTED_FEEDBACK_ON_SELF_EVENT`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Requested Feedback On Worker Event
>
> **Slug:** `WORKDAY_CREATE_WORKER_REQUESTED_FEEDBACK_ON_WORKER_EVENT`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Skill Items
>
> **Slug:** `WORKDAY_CREATE_WORKER_SKILL_ITEMS`
>
> Creates skill items in bulk for the specified worker. Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **skillItems** `array`
>
> The skill items to create for the worker. Each item represents a skill qualification.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Time Block
>
> **Slug:** `WORKDAY_CREATE_WORKER_TIME_BLOCK`
>
> Create 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
>
> **fund** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **gift** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **unit** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **grant** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **region** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **comment** `string`
>
> Comment for the time block.
>
> **in\_time** `string`
>
> Local ISO 8601 in-time for a flat in/out entry. Required with outTime and both time zones.
>
> **program** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **project** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **currency** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **location** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **out\_time** `string`
>
> Local ISO 8601 out-time for a flat in/out entry. Required with inTime and both time zones.
>
> **position** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **worker\_id** `string` *required*
>
> Workday ID of the worker, an Employee\_ID or Contingent\_Worker\_ID reference ID, or `me`.
>
> **out\_reason** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **api\_version** `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.
>
> **cost\_center** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **do\_not\_bill** `boolean`
>
> Whether project time is non-billable.
>
> **job\_profile** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **in\_time\_zone** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **project\_role** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **appropriation** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **business\_unit** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **calendar\_date** `string`
>
> Calendar date. Required with reportedQuantity for hourly entries; optional for flat in/out entries.
>
> **out\_time\_zone** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **override\_rate** `number`
>
> Override rate, when allowed by the time entry code.
>
> **allocation\_pool** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **time\_entry\_code** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **project\_plan\_task** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **reported\_quantity** `number`
>
> Positive hours or units for an hourly Worked Time entry. Omit for in/out entries.
>
> **project\_plan\_phase** `object`
>
> A Workday instance reference accepted for write compatibility.
>
> **additional\_worktags** `object`
>
> Additional customOrganization01 through 10 or customWorktag01 through 15 references.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Worker Time Review Event
>
> **Slug:** `WORKDAY_CREATE_WORKER_TIME_REVIEW_EVENT`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker (or 'me') for whom to submit time.
>
> **date** `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.
>
> **comment** `string`
>
> Comment that persists on each time review event. Only allowed if comments are enabled for the Enter Time business process.
>
> **timeReviewEvents** `array`
>
> Time Review Events created in the Submit Time request. Each entry can include worker, dates, and override fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Compensation Scorecard
>
> **Slug:** `WORKDAY_DELETE_COMPENSATION_SCORECARD`
>
> Deletes 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
>
> **ID** `string` *required*
>
> The Workday ID of the Compensation Scorecard to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Object
>
> **Slug:** `WORKDAY_DELETE_CUSTOM_OBJECT`
>
> Deletes 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
>
> **customObjectID** `string` *required*
>
> Either the extended Workday object ID or the custom object's own ID.
>
> **customObjectAlias** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Object Definition Condition Rule
>
> **Slug:** `WORKDAY_DELETE_CUSTOM_OBJECT_DEFINITION_CONDITION_RULE`
>
> Removes 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the condition rule.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the condition rule to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Object Definition Validation
>
> **Slug:** `WORKDAY_DELETE_CUSTOM_OBJECT_DEFINITION_VALIDATION`
>
> Removes 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the validation.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the validation to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Expense Entry
>
> **Slug:** `WORKDAY_DELETE_EXPENSE_ENTRY`
>
> Deletes 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
>
> **ID** `string` *required*
>
> The Workday ID of the Quick Expense entry to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Home Contact Change Address
>
> **Slug:** `WORKDAY_DELETE_HOME_CONTACT_CHANGE_ADDRESS`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Home Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_DELETE_HOME_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Home Contact Change Phone Number
>
> **Slug:** `WORKDAY_DELETE_HOME_CONTACT_CHANGE_PHONE_NUMBER`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Home Contact Change Web Address
>
> **Slug:** `WORKDAY_DELETE_HOME_CONTACT_CHANGE_WEB_ADDRESS`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Payroll Input
>
> **Slug:** `WORKDAY_DELETE_PAYROLL_INPUT`
>
> Deletes 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
>
> **ID** `string` *required*
>
> The Workday ID of the payroll input instance to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Scorecard Result
>
> **Slug:** `WORKDAY_DELETE_SCORECARD_RESULT`
>
> Deletes 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
>
> **ID** `string` *required*
>
> The Workday ID of the Scorecard Result to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Time Clock Event
>
> **Slug:** `WORKDAY_DELETE_TIME_CLOCK_EVENT`
>
> Delete 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
>
> **event\_id** `string` *required*
>
> Workday ID or Time\_Clock\_Event\_ID reference ID of the event to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Work Contact Change Address
>
> **Slug:** `WORKDAY_DELETE_WORK_CONTACT_CHANGE_ADDRESS`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Work Contact Change Email Address
>
> **Slug:** `WORKDAY_DELETE_WORK_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Work Contact Change Phone Number
>
> **Slug:** `WORKDAY_DELETE_WORK_CONTACT_CHANGE_PHONE_NUMBER`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Work Contact Change Web Address
>
> **Slug:** `WORKDAY_DELETE_WORK_CONTACT_CHANGE_WEB_ADDRESS`
>
> Remove 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Deny Business Process Event Step
>
> **Slug:** `WORKDAY_DENY_BUSINESS_PROCESS_EVENT_STEP`
>
> Denies 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event step to deny.
>
> **comment** `string`
>
> Optional denial comment recorded on the event step.
>
> **stepAction** `object`
>
> Optional step-action reference object (\{id} or \{id, descriptor}) selecting which deny variant to perform when multiple are configured on the step.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Discover One-Time Payment Options
>
> **Slug:** `WORKDAY_DISCOVER_ONE_TIME_PAYMENT_OPTIONS`
>
> Discover 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
>
> **worker\_id** `string` *required*
>
> Worker Employee ID, 32-character WID, or typed Employee\_ID/Contingent\_Worker\_ID reference used to discover effective positions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Discover Reference Values
>
> **Slug:** `WORKDAY_DISCOVER_REFERENCE_VALUES`
>
> Return 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
>
> **page** `integer`
>
> One-based page to return, bounded from 1 through 100.
>
> **count** `integer`
>
> Maximum reference values to return on this page, from 1 through 100.
>
> **use\_case** `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.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date for the reference values.
>
> **as\_of\_entry\_datetime** `string`
>
> Stable entry timestamp. Required after page 1 and reused across pages.
>
> **include\_defaulted\_values\_only** `boolean`
>
> Return only values matching the tenant's default reference ID format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Absence Balance
>
> **Slug:** `WORKDAY_GET_ABSENCE_BALANCE`
>
> Retrieves 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
>
> **worker** `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.
>
> **effective** `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.
>
> **absencePlan** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Absence Management Worker
>
> **Slug:** `WORKDAY_GET_ABSENCE_MANAGEMENT_WORKER`
>
> Retrieves 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
>
> **ID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Additional Names
>
> **Slug:** `WORKDAY_GET_ADDITIONAL_NAMES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the person resource. Example: 'WD-12345'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get and Set Up Scores on Scorecard Results
>
> **Slug:** `WORKDAY_GET_AND_SET_UP_SCORES_ON_SCORECARD_RESULTS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the scorecard results resource. This is a unique identifier for the scorecard result instance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assignment Change Group Cost Centers
>
> **Slug:** `WORKDAY_GET_ASSIGNMENT_CHANGE_GROUP_COST_CENTERS`
>
> Retrieves cost centers instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assignment Change Group Jobs
>
> **Slug:** `WORKDAY_GET_ASSIGNMENT_CHANGE_GROUP_JOBS`
>
> Retrieves jobs instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assignment Types
>
> **Slug:** `WORKDAY_GET_ASSIGNMENT_TYPES`
>
> Retrieves assignment types instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Process Event Attachments
>
> **Slug:** `WORKDAY_GET_ATTACHMENT_BUSINESS_PROCESS_EVENT`
>
> Lists 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event resource. Format: alphanumeric string (e.g., 'abc12345-xyz').
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment by External ID
>
> **Slug:** `WORKDAY_GET_ATTACHMENT_BY_EXTERNAL_ID`
>
> Retrieves 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
>
> **external\_id** `string` *required*
>
> The external identifier for the attachment. Example: 'AT1'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience Selection
>
> **Slug:** `WORKDAY_GET_AUDIENCE_SELECTION`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Audience Types
>
> **Slug:** `WORKDAY_GET_AUDIENCE_TYPES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Balance Details
>
> **Slug:** `WORKDAY_GET_BALANCE_DETAILS`
>
> Requests 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
>
> **worker** `string` *required*
>
> The Workday ID of the worker. This can be obtained from actions like 'Get Current User' or 'List Workers'.
>
> **effective** `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.
>
> **absencePlan** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Process
>
> **Slug:** `WORKDAY_GET_BUSINESS_PROCESS`
>
> Retrieves a business process event by its ID. Returns the status, current step, workflow steps, initiator, and subject information for the event.
>
> #### Input Parameters
>
> **ID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Process Event Step
>
> **Slug:** `WORKDAY_GET_BUSINESS_PROCESS_EVENT_STEP`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event step to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Process Type
>
> **Slug:** `WORKDAY_GET_BUSINESS_PROCESS_TYPE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process type to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Title Change
>
> **Slug:** `WORKDAY_GET_BUSINESS_TITLE_CHANGE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business title change instance. Example: '11111111111111111111111111111111'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Title Change For Worker
>
> **Slug:** `WORKDAY_GET_BUSINESS_TITLE_CHANGE_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker whose business title change you want to retrieve.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the business title change subresource (the specific business title change instance) for the worker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Case
>
> **Slug:** `WORKDAY_GET_CASE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the case to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Case Type
>
> **Slug:** `WORKDAY_GET_CASE_TYPE`
>
> Retrieve 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
>
> **case\_type\_id** `string` *required*
>
> The Workday ID of the case type to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Certification Issuers
>
> **Slug:** `WORKDAY_GET_CERTIFICATION_ISSUERS`
>
> Retrieves certification issuer records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Certifications
>
> **Slug:** `WORKDAY_GET_CERTIFICATIONS`
>
> Retrieves certification records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Check Ins
>
> **Slug:** `WORKDAY_GET_CHECK_INS`
>
> Retrieves check in records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Check In Topics
>
> **Slug:** `WORKDAY_GET_CHECK_IN_TOPICS`
>
> Retrieves check in topic records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection of Payroll
>
> **Slug:** `WORKDAY_GET_COLLECTION_OF_PAYROLL`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **worker** `array`
>
> The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service.
>
> **endDate** `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').
>
> **startDate** `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.
>
> **payComponent** `array`
>
> The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Companies Values
>
> **Slug:** `WORKDAY_GET_COMPANIES_VALUES`
>
> Retrieves company instances that can be used as values for other endpoint parameters in the Workday Staffing service (Organization Assignment Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Insider Types
>
> **Slug:** `WORKDAY_GET_COMPANY_INSIDER_TYPES`
>
> Retrieves company insider types instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Compensation Scorecard Info
>
> **Slug:** `WORKDAY_GET_COMPENSATION_SCORE_CARD_INFO`
>
> Retrieves a Workday compensation scorecard by ID, including available goals, profiles, eligibility rules, effective date, and status. Requires the Advanced Compensation scope.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the scorecard resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Compensation Scorecards
>
> **Slug:** `WORKDAY_GET_COMPENSATION_SCORECARDS`
>
> Lists 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **effectiveDate** `string`
>
> Effective date the scorecard task takes effect. Format: YYYY-MM-DD
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Competencies
>
> **Slug:** `WORKDAY_GET_COMPETENCIES`
>
> Retrieves competency records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Competency Categories
>
> **Slug:** `WORKDAY_GET_COMPETENCY_CATEGORIES`
>
> Retrieves competency category records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> **competency\_category\_id** `string`
>
> Optional Competency Category reference identifier.
>
> **competency\_category\_id\_type** `string`
>
> Identifier type for competency\_category\_id.
>
> **competency\_category\_references** `array`
>
> Optional additional Competency Category references to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Completed Steps Business Process
>
> **Slug:** `WORKDAY_GET_COMPLETED_STEPS_BUSINESS_PROCESS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event. This is a unique identifier for the specific business process instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contingent Worker Types
>
> **Slug:** `WORKDAY_GET_CONTINGENT_WORKER_TYPES`
>
> Retrieves contingent worker types instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Countries
>
> **Slug:** `WORKDAY_GET_COUNTRIES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Country Address Components
>
> **Slug:** `WORKDAY_GET_COUNTRY_ADDRESS_COMPONENTS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **currentAddress** `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.
>
> **useWesternScript** `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.
>
> **addressConfigurationFormat** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Country Info
>
> **Slug:** `WORKDAY_GET_COUNTRY_INFO`
>
> Retrieves detailed information about a specific country from Workday. Use this to get country metadata including ISO codes and address lookup settings.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the country resource. This is a unique identifier for the country in Workday's system. Example: '00000000000000000000000000000033'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Currencies
>
> **Slug:** `WORKDAY_GET_CURRENCIES`
>
> Retrieves currencies instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Currency
>
> **Slug:** `WORKDAY_GET_CURRENCY`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the currency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `WORKDAY_GET_CURRENT_USER`
>
> Retrieves the current authenticated worker's profile information from Workday.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Field Type
>
> **Slug:** `WORKDAY_GET_CUSTOM_FIELD_TYPE`
>
> Retrieves a custom field type by ID, returning its ID, display descriptor and API link when available.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the custom field type to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Field Type List Value
>
> **Slug:** `WORKDAY_GET_CUSTOM_FIELD_TYPE_LIST_VALUE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom field type (custom list) that owns the list value.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the list value to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Object
>
> **Slug:** `WORKDAY_GET_CUSTOM_OBJECT`
>
> Retrieves 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
>
> **customObjectID** `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.
>
> **customObjectAlias** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Object Definition
>
> **Slug:** `WORKDAY_GET_CUSTOM_OBJECT_DEFINITION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Object Definition Condition Rule
>
> **Slug:** `WORKDAY_GET_CUSTOM_OBJECT_DEFINITION_CONDITION_RULE`
>
> Retrieves a single condition rule attached to a custom object definition, returning its ID, descriptor, and resource URL when available.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the condition rule.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the condition rule to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Object Definition Field
>
> **Slug:** `WORKDAY_GET_CUSTOM_OBJECT_DEFINITION_FIELD`
>
> Retrieves a single field belonging to a custom object definition, returning its ID, descriptor, and resource URL when available.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the field.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the field to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Object Definition Validation
>
> **Slug:** `WORKDAY_GET_CUSTOM_OBJECT_DEFINITION_VALIDATION`
>
> Retrieves a single validation attached to a custom object definition by its ID. The response exposes its ID, descriptor, and resource link.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the validation.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the validation to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Degrees
>
> **Slug:** `WORKDAY_GET_DEGREES`
>
> Retrieves degree records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Compensation
>
> **Slug:** `WORKDAY_GET_EMPLOYEE_COMPENSATION`
>
> Retrieves 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
>
> **ID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Enrollment Event
>
> **Slug:** `WORKDAY_GET_EMPLOYEE_ENROLLMENT_EVENT`
>
> Retrieves a benefit enrollment event for the processing worker by enrollment event ID.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the employee enrollment event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Reviews
>
> **Slug:** `WORKDAY_GET_EMPLOYEE_REVIEWS`
>
> Exports in-progress and completed employee reviews from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of employee reviews to return in this page. Workday supports values from 1 through 999.
>
> **employee\_review\_id** `string`
>
> Optional employee review identifier. Omit to retrieve a paginated set of in-progress and completed employee reviews.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format. If omitted, Workday defaults to today's effective date.
>
> **as\_of\_entry\_datetime** `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.
>
> **employee\_review\_id\_type** `string ("WID" | "Employee_Review_ID")`
>
> Identifier type for employee\_review\_id. Use WID for Workday IDs and Employee\_Review\_ID for reference IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Review Templates
>
> **Slug:** `WORKDAY_GET_EMPLOYEE_REVIEW_TEMPLATES`
>
> Retrieves employee review template records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> **employee\_review\_template\_id** `string`
>
> Optional Employee Review Template reference identifier.
>
> **employee\_review\_template\_id\_type** `string`
>
> Identifier type for employee\_review\_template\_id.
>
> **employee\_review\_template\_references** `array`
>
> Optional additional Employee Review Template references to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Types
>
> **Slug:** `WORKDAY_GET_EMPLOYEE_TYPES`
>
> Retrieves employee type instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Expense Entry
>
> **Slug:** `WORKDAY_GET_EXPENSE_ENTRY`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the Quick Expense entry to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Expense Item
>
> **Slug:** `WORKDAY_GET_EXPENSE_ITEM`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the expense item to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Expense Report
>
> **Slug:** `WORKDAY_GET_EXPENSE_REPORT`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday Identifier (WID) of the expense report to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback Badge By Id
>
> **Slug:** `WORKDAY_GET_FEEDBACK_BADGE_BY_ID`
>
> Retrieves a Feedback Badge with the specified ID. Use when you need to read this Workday data via the Performance Enablement REST API.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback Badges
>
> **Slug:** `WORKDAY_GET_FEEDBACK_BADGES`
>
> Retrieves feedback badge records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback Questions
>
> **Slug:** `WORKDAY_GET_FEEDBACK_QUESTIONS`
>
> Retrieves feedback question records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> **feedback\_question\_id** `string`
>
> Optional Feedback Question reference identifier.
>
> **feedback\_question\_id\_type** `string`
>
> Identifier type for feedback\_question\_id.
>
> **feedback\_question\_references** `array`
>
> Optional additional Feedback Question references to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Fields Of Study
>
> **Slug:** `WORKDAY_GET_FIELDS_OF_STUDY`
>
> Retrieves field of study records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Gifts
>
> **Slug:** `WORKDAY_GET_GIFTS`
>
> Retrieves gift (organization) instances that can be used as values for other endpoint parameters in the Workday Staffing service (Organization Assignment Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Give Requested Feedback Event By Id
>
> **Slug:** `WORKDAY_GET_GIVE_REQUESTED_FEEDBACK_EVENT_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Goal Payout Bands
>
> **Slug:** `WORKDAY_GET_GOAL_PAYOUT_BANDS`
>
> Retrieves goal payout band records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Goal Units
>
> **Slug:** `WORKDAY_GET_GOAL_UNITS`
>
> Retrieves goal unit records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Grants
>
> **Slug:** `WORKDAY_GET_GRANTS`
>
> Retrieves grants instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Graph API Version
>
> **Slug:** `WORKDAY_GET_GRAPH_API_VERSION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the Graph API version resource to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Headcount Options
>
> **Slug:** `WORKDAY_GET_HEADCOUNT_OPTIONS`
>
> Retrieves headcount options instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get History Items for Worker
>
> **Slug:** `WORKDAY_GET_HISTORY_ITEMS_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker. Can be obtained from actions like 'Get Current User' or 'List Workers'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Holiday Events
>
> **Slug:** `WORKDAY_GET_HOLIDAY_EVENTS`
>
> Returns the holiday events for the specified workers and time period.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **toDate** `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.
>
> **worker** `array`
>
> Array of worker IDs to filter holiday events for specific workers.
>
> **fromDate** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Address
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_ADDRESS`
>
> An 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Email Address
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> An 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Email Addresses
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_EMAIL_ADDRESSES`
>
> Retrieve 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public email addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary email addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Event Information
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_EVENT_INFORMATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the Home Contact Change event resource. This is typically a WID format identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> An 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Instant Messengers
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_INSTANT_MESSENGERS`
>
> Retrieve 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public instant messenger account usernames.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary instant messenger account usernames.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Phone Number
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_PHONE_NUMBER`
>
> A 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Phone Numbers
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_PHONE_NUMBERS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public phone numbers.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary phone numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Web Address
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_WEB_ADDRESS`
>
> A 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Change Web Addresses
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_CHANGE_WEB_ADDRESSES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public web addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary web addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Contact Information Change
>
> **Slug:** `WORKDAY_GET_HOME_CONTACT_INFORMATION_CHANGE`
>
> Retrieves an existing Home Contact Change event for the worker's Person. Secured by: Change Home Contact Information (REST Service) Scope: Contact Information
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Home Contact Change event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Home Web Addresses
>
> **Slug:** `WORKDAY_GET_HOME_WEB_ADDRESSES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public web addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary web addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Import Processes
>
> **Slug:** `WORKDAY_GET_IMPORT_PROCESSES`
>
> Retrieves the status and completion details of a Workday import process.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **import\_process\_id** `string` *required*
>
> The import process runtime identifier returned by an asynchronous Workday import operation, such as Import Employee Reviews.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `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.
>
> **import\_process\_id\_type** `string ("WID" | "Background_Process_Instance_ID")`
>
> Identifier type for import\_process\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Import Process Messages
>
> **Slug:** `WORKDAY_GET_IMPORT_PROCESS_MESSAGES`
>
> Retrieves errors, warnings, and details emitted by a Workday import process.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **import\_process\_id** `string` *required*
>
> The import process runtime identifier returned by an asynchronous Workday import operation, such as Import Employee Reviews.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `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.
>
> **import\_process\_id\_type** `string ("WID" | "Background_Process_Instance_ID")`
>
> Identifier type for import\_process\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get In Process Steps Business Process Event
>
> **Slug:** `WORKDAY_GET_IN_PROCESS_STEPS_BUSINESS_PROCESS_EVENT`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event. This is a unique identifier for the specific business process instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interview
>
> **Slug:** `WORKDAY_GET_INTERVIEW`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interview Feedback
>
> **Slug:** `WORKDAY_GET_INTERVIEW_FEEDBACK`
>
> Retrieves 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
>
> **ID** `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.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interview Feedback
>
> **Slug:** `WORKDAY_GET_INTERVIEW_FEEDBACK2`
>
> Retrieves 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
>
> **id** `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.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job By ID
>
> **Slug:** `WORKDAY_GET_JOB_BY_ID`
>
> Tool 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
>
> **ID** `string` *required*
>
> The Workday ID of the job resource. This is a unique identifier for the job instance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Change Frequencies
>
> **Slug:** `WORKDAY_GET_JOB_CHANGE_FREQUENCIES`
>
> Retrieves frequencies instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Change Location Info
>
> **Slug:** `WORKDAY_GET_JOB_CHANGE_LOCATION_INFO`
>
> Tool 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a unique identifier for a specific job change event.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Change Reason
>
> **Slug:** `WORKDAY_GET_JOB_CHANGE_REASON`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change reason resource. A 32-character hexadecimal string (e.g., '00000000000000000000000000000024').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Change Reason Values
>
> **Slug:** `WORKDAY_GET_JOB_CHANGE_REASON_VALUES`
>
> Retrieves job change reasons instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Administrative
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_ADMINISTRATIVE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Administrative by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_ADMINISTRATIVE_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the administrative subresource. For singleton subresources like administrative, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Business Title
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_BUSINESS_TITLE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Business Title by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_BUSINESS_TITLE_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the businessTitle subresource. For singleton subresources like businessTitle, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes By ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a unique identifier for the job change event instance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Comment By ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_COMMENT_BY_ID`
>
> Returns 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
>
> **ID** `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').
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Comment by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_COMMENT_BY_SUBRESOURCE_ID`
>
> Returns 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the comment subresource. For singleton subresources like comment, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Contract
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_CONTRACT`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Contract Options
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_CONTRACT_OPTIONS`
>
> Retrieves 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
>
> **ID** `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').
>
> **subresourceID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Group Templates
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_GROUP_TEMPLATES`
>
> Retrieves templates instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Job Classification
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_JOB_CLASSIFICATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a 32-character hexadecimal string that uniquely identifies the job change instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Job Classification by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_JOB_CLASSIFICATION_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the jobClassification subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Job Profile
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_JOB_PROFILE`
>
> Retrieves 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
>
> **ID** `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').
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Job Profile by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_JOB_PROFILE_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the jobProfile subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Job Values
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_JOB_VALUES`
>
> Retrieves jobs instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Location by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_LOCATION_BY_ID`
>
> Returns 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the location subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Move Team
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_MOVE_TEAM`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Move Team by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_MOVE_TEAM_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the moveTeam subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Opening Options
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_OPENING_OPTIONS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource. This is a unique identifier for the job change instance.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Opening Option by ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_OPENING_OPTIONS2`
>
> Retrieves 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
>
> **ID** `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').
>
> **subresourceID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Position By ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_POSITION_BY_ID`
>
> Retrieves 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
>
> **ID** `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').
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Change Position by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_POSITION_BY_SUBRESOURCE_ID`
>
> Retrieves 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
>
> **ID** `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').
>
> **subresourceID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Start Details
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_START_DETAILS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Start Details by Subresource ID
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_START_DETAILS_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the startDetails subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Changes Worker Values
>
> **Slug:** `WORKDAY_GET_JOB_CHANGES_WORKER_VALUES`
>
> Retrieves workers instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Classifications
>
> **Slug:** `WORKDAY_GET_JOB_CLASSIFICATIONS`
>
> Retrieves job classifications instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Family
>
> **Slug:** `WORKDAY_GET_JOB_FAMILY`
>
> Retrieves a single job family instance with the specified Workday ID from the Staffing service.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the job family resource to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Posting
>
> **Slug:** `WORKDAY_GET_JOB_POSTING`
>
> Retrieves detailed information about a specific job posting including job description.
>
> #### Input Parameters
>
> **ID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Posting Candidate Availability Template
>
> **Slug:** `WORKDAY_GET_JOB_POSTING_CANDIDATE_AVAILABILITY_TEMPLATE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource (job posting).
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Posting Questionnaire
>
> **Slug:** `WORKDAY_GET_JOB_POSTING_QUESTIONNAIRE`
>
> Retrieves screening questions and questionnaires associated with a specific job posting.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the job posting resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **questionnaireType** `array`
>
> Filter questionnaires by type (e.g., screening, pre-hire). Accepts multiple types.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Posting Questionnaire By ID
>
> **Slug:** `WORKDAY_GET_JOB_POSTING_QUESTIONNAIRE_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource (job posting).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the questionnaire instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Profile
>
> **Slug:** `WORKDAY_GET_JOB_PROFILE`
>
> Retrieves a single job profile instance with the specified Workday ID from the Staffing service.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the job profile resource to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Profiles Values
>
> **Slug:** `WORKDAY_GET_JOB_PROFILES_VALUES`
>
> Retrieves job profiles instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Requisition Values
>
> **Slug:** `WORKDAY_GET_JOB_REQUISITION_VALUES`
>
> Retrieves job requisitions instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Workspace
>
> **Slug:** `WORKDAY_GET_JOB_WORKSPACE`
>
> Tool 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
>
> **ID** `string` *required*
>
> The Workday ID of the job resource. This is the unique identifier for the job whose workspace information you want to retrieve.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the workspace subresource. This is the unique identifier for the specific workspace instance within the job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Workspaces
>
> **Slug:** `WORKDAY_GET_JOB_WORKSPACES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job resource. This is the unique identifier for the job whose workspaces you want to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Learning Content
>
> **Slug:** `WORKDAY_GET_LEARNING_CONTENT`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the learning content to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Learning Content Lesson
>
> **Slug:** `WORKDAY_GET_LEARNING_CONTENT_LESSON`
>
> Retrieves a single lesson for a learning content item.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the learning content.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the lesson.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Learning Record
>
> **Slug:** `WORKDAY_GET_LEARNING_RECORD`
>
> Retrieves a single learning record with the specified ID.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the learning record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Leave Status Values
>
> **Slug:** `WORKDAY_GET_LEAVE_STATUS_VALUES`
>
> Get 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Location Values
>
> **Slug:** `WORKDAY_GET_LOCATION_VALUES`
>
> Retrieves location instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mentorship
>
> **Slug:** `WORKDAY_GET_MENTORSHIP`
>
> Returns 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
>
> **ID** `string` *required*
>
> The Workday ID of the mentorship to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message Template By ID
>
> **Slug:** `WORKDAY_GET_MESSAGE_TEMPLATE_BY_ID`
>
> Retrieves a message template with the specific ID.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the message template to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Minimum Wage Rates Countries Values
>
> **Slug:** `WORKDAY_GET_MINIMUM_WAGE_RATES_COUNTRIES_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Minimum Wage Rates Tax Authorities Values
>
> **Slug:** `WORKDAY_GET_MINIMUM_WAGE_RATES_TAX_AUTHORITIES_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get My Job Postings
>
> **Slug:** `WORKDAY_GET_MY_JOB_POSTINGS`
>
> Finds 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
>
> **limit** `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.
>
> **include\_closed** `boolean`
>
> Whether to include closed job postings in the results. If False, only returns currently open postings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Country Name Components
>
> **Slug:** `WORKDAY_GET_NAME_COMPONENTS`
>
> Retrieves 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
>
> **ID** `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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **currentName** `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.
>
> **useWesternScript** `boolean`
>
> If true, this method returns the set of allowed and required name components that uses Western Script. The default is false.
>
> **nameConfigurationFormat** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Name Pronunciations
>
> **Slug:** `WORKDAY_GET_NAME_PRONUNCIATIONS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the person resource. This is a unique identifier for the person in Workday's system. Example: '00000000000000000000000000000000'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **currentAudio** `boolean`
>
> Download only the currently active audio. When set to true, only the active pronunciation audio will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Notification Type By ID
>
> **Slug:** `WORKDAY_GET_NOTIFICATION_TYPE_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the notification type to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization
>
> **Slug:** `WORKDAY_GET_ORGANIZATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization to retrieve. Example: 'WORKDAY-ORG-001' or 'Supervisory\_Organization\_123'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Business Units
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_BUSINESS_UNITS`
>
> Retrieves business units instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Change
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGE`
>
> Retrieves an organization assignment change event by ID from the Workday Staffing API, returning its ID and descriptor when available.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Business Unit
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_BUSINESS_UNIT`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Comment
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMMENT`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Comment By ID
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMMENT_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the comment subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Company
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMPANY`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Company By ID
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COMPANY_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the company subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Cost Center
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_COST_CENTER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Region
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_REGION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Region By ID
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_REGION_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the region subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Start Details
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CHANGES_START_DETAILS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Customs
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_CUSTOMS`
>
> Retrieves custom organizations instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Funds
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_FUNDS`
>
> Retrieves funds instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Regions
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_REGIONS`
>
> Retrieves regions instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Workers
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_ASSIGNMENT_WORKERS`
>
> Retrieves workers instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Goals
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_GOALS`
>
> Retrieves organization goal records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Type
>
> **Slug:** `WORKDAY_GET_ORGANIZATION_TYPE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization type to retrieve. This is a unique identifier for the organization type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Business Unit By ID
>
> **Slug:** `WORKDAY_GET_ORG_ASSIGN_CHANGES_BUSINESS_UNIT_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the businessUnit subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Cost Center By ID
>
> **Slug:** `WORKDAY_GET_ORG_ASSIGN_CHANGES_COST_CENTER_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the costCenter subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Custom Organizations
>
> **Slug:** `WORKDAY_GET_ORG_ASSIGN_CHANGES_CUSTOM_ORGS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Custom Organizations By ID
>
> **Slug:** `WORKDAY_GET_ORG_ASSIGN_CHANGES_CUSTOM_ORGS_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the customOrganizations subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Assignment Changes Start Details By ID
>
> **Slug:** `WORKDAY_GET_ORG_ASSIGN_CHANGES_START_DETAILS_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the startDetails subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organizations for Worker
>
> **Slug:** `WORKDAY_GET_ORG_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker. Example: '00000000000000000000000000000000'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Group
>
> **Slug:** `WORKDAY_GET_PAY_GROUP`
>
> Retrieves a single pay group instance by its Workday ID.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the pay group resource. This is a unique identifier for the pay group instance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Group by Job ID
>
> **Slug:** `WORKDAY_GET_PAY_GROUP_BY_JOB_ID`
>
> Retrieves the pay group for a specified job ID. This method always returns 1 pay group.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the job. This is the job identifier for which to retrieve the pay group information.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **effective** `string`
>
> The effective date of the pay group, using the date format yyyy-mm-dd.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Group Detail
>
> **Slug:** `WORKDAY_GET_PAY_GROUP_DETAIL`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the pay group detail instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Rate Types Values
>
> **Slug:** `WORKDAY_GET_PAY_RATE_TYPES_VALUES`
>
> Retrieves pay rate types instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payroll Input Instance
>
> **Slug:** `WORKDAY_GET_PAYROLL_INPUT_INSTANCE`
>
> Retrieves a single payroll input instance with the specified Workday ID.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the payroll input instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payroll Interface Pay Group
>
> **Slug:** `WORKDAY_GET_PAYROLL_INTERFACE_PAY_GROUP`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the Payroll Interface pay group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payroll Interface Pay Group Period
>
> **Slug:** `WORKDAY_GET_PAYROLL_INTERFACE_PAY_GROUP_PERIOD`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the pay group.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the pay period.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payroll Job
>
> **Slug:** `WORKDAY_GET_PAYROLL_JOB`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job (position) to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payroll Job Pay Group
>
> **Slug:** `WORKDAY_GET_PAYROLL_JOB_PAY_GROUP`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the job (position) whose pay group is being retrieved.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the pay group instance to retrieve under the job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Slip Instance for Worker
>
> **Slug:** `WORKDAY_GET_PAY_SLIP_INSTANCES_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the pay slip subresource (a specific pay slip instance for the worker).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pay Slips for Worker
>
> **Slug:** `WORKDAY_GET_PAY_SLIPS_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Performance Worker By Id
>
> **Slug:** `WORKDAY_GET_PERFORMANCE_WORKER_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person
>
> **Slug:** `WORKDAY_GET_PERSON`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Address
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_ADDRESS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Addresses
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_ADDRESSES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **effective** `string`
>
> The effective date of the person's addresses using the yyyy-mm-dd format.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Email
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_EMAIL`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Emails
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_EMAILS`
>
> Retrieves a page of home email addresses for a person in Workday, with optional pagination and usage filters.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the person resource. Example: '12345'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public email addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary email addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Instant Messenger
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_INSTANT_MESSENGER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Instant Messengers
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_INSTANT_MESSENGERS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public instant messenger usernames.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary instant messenger account usernames.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Phone
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_PHONE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Home Phones
>
> **Slug:** `WORKDAY_GET_PERSON_HOME_PHONES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public phone numbers.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary phone numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Legal Name
>
> **Slug:** `WORKDAY_GET_PERSON_LEGAL_NAME`
>
> Retrieves a paginated collection of a person's legal name records using Workday's person v4 API. Secured by Person Data: Legal Name and Self-Service: Legal Name; scope: Contact Information.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Legal Name By Id
>
> **Slug:** `WORKDAY_GET_PERSON_LEGAL_NAME_BY_ID`
>
> Retrieves the legal name instance. Use this action when integrating Workday's person v4 API and you need to get this specific resource. Secured by: Person Data: Legal Name, Self-Service: Legal Name. Scope: Contact Information.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Personal Information
>
> **Slug:** `WORKDAY_GET_PERSON_PERSONAL_INFORMATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the person resource. Example: '12345'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> **country** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Photo
>
> **Slug:** `WORKDAY_GET_PERSON_PHOTO`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Photos
>
> **Slug:** `WORKDAY_GET_PERSON_PHOTOS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Preferred Name
>
> **Slug:** `WORKDAY_GET_PERSON_PREFERRED_NAME`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Preferred Name By Id
>
> **Slug:** `WORKDAY_GET_PERSON_PREFERRED_NAME_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Public Contact Information
>
> **Slug:** `WORKDAY_GET_PERSON_PUBLIC_CONTACT_INFORMATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Address
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_ADDRESS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Addresses
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_ADDRESSES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **effective** `string`
>
> The effective date of the person's addresses using the yyyy-mm-dd format.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Email
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_EMAIL`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Emails
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_EMAILS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public email addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary email addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Instant Messenger
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_INSTANT_MESSENGER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Instant Messengers
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_INSTANT_MESSENGERS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public instant messenger usernames.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary instant messenger account usernames.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Phone
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_PHONE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Phones
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_PHONES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public phone numbers.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary phone numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Web Address
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_WEB_ADDRESS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person Work Web Addresses
>
> **Slug:** `WORKDAY_GET_PERSON_WORK_WEB_ADDRESSES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.  - **ID:** Replace with your actual Workday ID - **me** Sentinel values: 'ID', 'me'.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public web addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary web addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Phone Device Types
>
> **Slug:** `WORKDAY_GET_PHONE_DEVICE_TYPES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default and maximum is 1000.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Position Values
>
> **Slug:** `WORKDAY_GET_POSITION_VALUES`
>
> Retrieves positions instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Programs
>
> **Slug:** `WORKDAY_GET_PROGRAMS`
>
> Retrieves program (organization) instances that can be used as values for other endpoint parameters in the Workday Staffing service (Organization Assignment Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project by External ID
>
> **Slug:** `WORKDAY_GET_PROJECT_BY_EXTERNAL_ID`
>
> Retrieves a Workday project by its external identifier. Available project details may include its name, status, dates, financials, hierarchy, and worktags.
>
> #### Input Parameters
>
> **external\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Milestone Report Schema
>
> **Slug:** `WORKDAY_GET_PROJECT_MILESTONE_REPORT_SCHEMA`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Type By ID
>
> **Slug:** `WORKDAY_GET_PROJECT_TYPE`
>
> Retrieves a project type by ID from the Workday Spend Projects service. Available details may include its name, description, and associated projects.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The unique identifier of the project type to retrieve. This is a string representation of the project type ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Proposed Position Values
>
> **Slug:** `WORKDAY_GET_PROPOSED_POSITION_VALUES`
>
> Retrieves proposed positions instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect
>
> **Slug:** `WORKDAY_GET_PROSPECT`
>
> Retrieves a single prospect instance for talent matching and best-fit analysis.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The unique Workday ID (WID) of the prospect. Must be a 32-character hexadecimal string (e.g., 'a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Education By ID
>
> **Slug:** `WORKDAY_GET_PROSPECT_EDUCATION_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource (prospect).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the specific education instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Educations
>
> **Slug:** `WORKDAY_GET_PROSPECT_EDUCATIONS`
>
> Retrieves 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
>
> **ID** `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.
>
> **limit** `integer`
>
> The maximum number of education objects to return in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first education object in the response collection. Use with limit for pagination. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Experience By ID
>
> **Slug:** `WORKDAY_GET_PROSPECT_EXPERIENCE_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource (prospect).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the specific work experience instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Experiences
>
> **Slug:** `WORKDAY_GET_PROSPECT_EXPERIENCES`
>
> Retrieves the work experience of a prospect for talent matching and best-fit analysis.
>
> #### Input Parameters
>
> **ID** `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.
>
> **limit** `integer`
>
> The maximum number of work experience objects to return in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Languages
>
> **Slug:** `WORKDAY_GET_PROSPECT_LANGUAGES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource (prospect).
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Resume Attachments
>
> **Slug:** `WORKDAY_GET_PROSPECT_RESUME_ATTACHMENTS`
>
> Retrieves resume attachments for a specific prospect to help prepare for upcoming interviews.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the prospect resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Skill By ID
>
> **Slug:** `WORKDAY_GET_PROSPECT_SKILL_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource (prospect).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the specific skill instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospect Skills
>
> **Slug:** `WORKDAY_GET_PROSPECT_SKILLS`
>
> Retrieves 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
>
> **ID** `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.
>
> **limit** `integer`
>
> The maximum number of skill objects to return in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first skill object in the response collection. Use with limit for pagination. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rating Scales
>
> **Slug:** `WORKDAY_GET_RATING_SCALES`
>
> Retrieves rating scale records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **response\_group** `object`
>
> Optional Workday Response\_Group object. Use Workday SOAP element names as keys, for example \{'Include\_Reference': true}.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Request
>
> **Slug:** `WORKDAY_GET_REQUEST`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the request to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Requested Feedback Events on Worker
>
> **Slug:** `WORKDAY_GET_REQUESTED_FEEDBACK_EVENTS_ON_WORKER`
>
> Retrieves a page of requested feedback events for a specified worker, including available status, expiration date, responder, template and question details.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Example: '00000000000000000000000000000000'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Request Type
>
> **Slug:** `WORKDAY_GET_REQUEST_TYPE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the request type to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Requisition Template
>
> **Slug:** `WORKDAY_GET_REQUISITION_TEMPLATE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> Workday ID of the requisition template to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Review Question Categories
>
> **Slug:** `WORKDAY_GET_REVIEW_QUESTION_CATEGORIES`
>
> Retrieves review question category records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> **review\_question\_category\_id** `string`
>
> Optional Review Question Category reference identifier.
>
> **review\_question\_category\_id\_type** `string`
>
> Identifier type for review\_question\_category\_id.
>
> **review\_question\_category\_references** `array`
>
> Optional additional Review Question Category references to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Review Questions
>
> **Slug:** `WORKDAY_GET_REVIEW_QUESTIONS`
>
> Retrieves review question records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Review Types
>
> **Slug:** `WORKDAY_GET_REVIEW_TYPES`
>
> Retrieves review type records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get School Types
>
> **Slug:** `WORKDAY_GET_SCHOOL_TYPES`
>
> Retrieves school type records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Skill Source Precedences
>
> **Slug:** `WORKDAY_GET_SKILL_SOURCE_PRECEDENCES`
>
> Retrieves skill source precedence records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> **skill\_source\_precedence\_request\_id** `string`
>
> Optional Skill Source Precedence Request reference identifier.
>
> **skill\_source\_precedence\_request\_id\_type** `string`
>
> Identifier type for skill\_source\_precedence\_request\_id.
>
> **skill\_source\_precedence\_request\_references** `array`
>
> Optional additional Skill Source Precedence Request references to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organization
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORGANIZATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the supervisory organization to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organization Member
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORGANIZATION_MEMBER`
>
> Retrieves a single member instance for the specified supervisory organization ID and member subresource ID from the Staffing service.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the supervisory organization.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the member (subresource) within the supervisory organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organization Members
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORGANIZATION_MEMBERS`
>
> Retrieves 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
>
> **ID** `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').
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organization Org Chart
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORGANIZATION_ORG_CHART`
>
> Retrieves the organization chart (superior and subordinate organizations) for the specified supervisory organization ID from the Staffing service.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the supervisory organization whose org chart will be retrieved.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organization Org Chart Instance
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORGANIZATION_ORG_CHART_INSTANCE`
>
> Retrieves a single organization chart instance for the specified supervisory organization ID and org-chart subresource ID from the Staffing service.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the supervisory organization.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the org chart entry (subresource) within the supervisory organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Org Managed by Worker
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORG_MANAGED_BY_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the supervisory organization subresource managed by the worker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organizations Managed By Worker
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORGS_MANAGED_BY_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker. Example: '00000000000000000000000000000000'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Supervisory Organization Values
>
> **Slug:** `WORKDAY_GET_SUPERVISORY_ORG_VALUES`
>
> Retrieves supervisory organizations instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Tax Rates Company Instances Values
>
> **Slug:** `WORKDAY_GET_TAX_RATES_COMPANY_INSTANCES_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Tax Rates State Instances Values
>
> **Slug:** `WORKDAY_GET_TAX_RATES_STATE_INSTANCES_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Clock Event
>
> **Slug:** `WORKDAY_GET_TIME_CLOCK_EVENT`
>
> Retrieve 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
>
> **event\_id** `string` *required*
>
> Workday ID or Time\_Clock\_Event\_ID reference ID of the event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Off Entries for Worker
>
> **Slug:** `WORKDAY_GET_TIME_OFF_ENTRIES_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Can be obtained from 'Get Current User' or 'List Workers' actions.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Off Entry for Worker
>
> **Slug:** `WORKDAY_GET_TIME_OFF_ENTRY_FOR_WORKER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Can be obtained from 'Get Current User' or 'List Workers' actions.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the time off entry subresource. Can be obtained from the 'Get Time Off Entries for Worker' action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Off Plan
>
> **Slug:** `WORKDAY_GET_TIME_OFF_PLAN`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the time off plan subresource (absence plan) for the worker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Off Plans For Worker
>
> **Slug:** `WORKDAY_GET_TIME_OFF_PLANS_FOR_WORKER`
>
> Retrieves 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
>
> **id** `string` *required*
>
> The Workday ID of the worker resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Off Status Values
>
> **Slug:** `WORKDAY_GET_TIME_OFF_STATUS_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time Types
>
> **Slug:** `WORKDAY_GET_TIME_TYPES`
>
> Retrieves time types instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Update Employee Review Ratings
>
> **Slug:** `WORKDAY_GET_UPDATE_EMPLOYEE_REVIEW_RATINGS`
>
> Retrieves update employee review rating records from Workday Performance Management.
>
> #### Input Parameters
>
> **page** `integer`
>
> The numbered page of data to return. Workday pages are 1-based.
>
> **count** `integer`
>
> Number of objects to return in this page.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date filter in YYYY-MM-DD format.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional entry moment filter as a Workday dateTime value, for example 2026-07-06T00:00:00.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the Work Contact Information Change resource (the business process event ID).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Addresses
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_ADDRESSES`
>
> Retrieve 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Query parameter usedFor.
>
> **publicOnly** `boolean`
>
> Query parameter publicOnly.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Email Address
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> An 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Email Addresses
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_EMAIL_ADDRESSES`
>
> Retrieve 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public email addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary email addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> An 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Instant Messengers
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_INSTANT_MESSENGERS`
>
> Retrieve 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public instant messenger account usernames.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary instant messenger account usernames.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Phone Number
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_PHONE_NUMBER`
>
> A 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Phone Numbers
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_PHONE_NUMBERS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public phone numbers.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary phone numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Web Address
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_WEB_ADDRESS`
>
> A 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Change Web Addresses
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_CHANGE_WEB_ADDRESSES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **usedFor** `string`
>
> Specifies usage behavior, such as mailing, billing, or shipping. Optional.
>
> **usageType** `string`
>
> Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
>
> **publicOnly** `boolean`
>
> If true, returns only the IDs of the person's public web addresses.
>
> **primaryOnly** `boolean`
>
> If true, returns only the IDs of the person's primary web addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Contact Information Change
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_INFORMATION_CHANGE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Work Contact Change event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Address As Staged
>
> **Slug:** `WORKDAY_GET_WORK_CONTACT_INFORMATION_CHANGES_ADDRESS_AS_STAGED`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the work contact information change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the address subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker
>
> **Slug:** `WORKDAY_GET_WORKER`
>
> Retrieves current staffing information for a specified non-terminated worker by Workday ID through the Staffing service, including available job and organizational details.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker to retrieve. Example: '00000000000000000000000000000000'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker (Time Tracking)
>
> **Slug:** `WORKDAY_GET_WORKER2`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker to retrieve. Accepts a real WID or the literal 'me'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Anytime Feedback Event By Id
>
> **Slug:** `WORKDAY_GET_WORKER_ANYTIME_FEEDBACK_EVENT_BY_ID`
>
> Retrieves a specified worker's feedback given event through the Performance Enablement REST API, returning its ID, descriptor and link when available.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Business Title Changes
>
> **Slug:** `WORKDAY_GET_WORKER_BUSINESS_TITLE_CHANGES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker. Can be obtained from 'Get Current User' or 'List Workers' actions.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Check-In
>
> **Slug:** `WORKDAY_GET_WORKER_CHECK_IN`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Check-In instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Check-Ins
>
> **Slug:** `WORKDAY_GET_WORKER_CHECK_INS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker whose Check-Ins to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in the response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Check-In Topic
>
> **Slug:** `WORKDAY_GET_WORKER_CHECK_IN_TOPIC`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Check-In topic instance to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Check-In Topics
>
> **Slug:** `WORKDAY_GET_WORKER_CHECK_IN_TOPICS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker whose Check-In topics to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in the response collection. The default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Development Item By Id
>
> **Slug:** `WORKDAY_GET_WORKER_DEVELOPMENT_ITEM_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Eligible Absence Types
>
> **Slug:** `WORKDAY_GET_WORKER_ELIGIBLE_ABSENCE_TYPES`
>
> Retrieves 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
>
> **ID** `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.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **category** `string`
>
> The Workday ID of the absence type category. Valid values: Leave of Absence Type (00000000000000000000000000000102), Absence Table (00000000000000000000000000000103), Time Off (00000000000000000000000000000005).
>
> **effective** `string`
>
> The effective date for which eligible absence types need to be returned for the worker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Explicit Skill
>
> **Slug:** `WORKDAY_GET_WORKER_EXPLICIT_SKILL`
>
> Retrieves a single explicit-skill usage for the specified worker. Secured by: Person Data: Skills, Self-Service: Skills Scope: Worker Profile and Skills
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the explicit-skill usage to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Explicit Skills
>
> **Slug:** `WORKDAY_GET_WORKER_EXPLICIT_SKILLS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker whose explicit skills to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **skill** `string`
>
> Retrieves the skills for the specified skill name.
>
> **offset** `integer`
>
> The zero-based index of the first object in the response collection. The default is 0.
>
> **skillSource** `string`
>
> The Workday ID of the skill source. Returns skills associated with the skill source.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker External Skill Levels
>
> **Slug:** `WORKDAY_GET_WORKER_EXTERNAL_SKILL_LEVELS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in the response collection. The default is 0.
>
> **externalSkillId** `string`
>
> If passed, the external skill level associated with the External Skill ID is returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker for Supervisory Org
>
> **Slug:** `WORKDAY_GET_WORKER_FOR_SUPERVISORY_ORG`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the supervisory organization.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the worker subresource within the supervisory organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Goal By Id
>
> **Slug:** `WORKDAY_GET_WORKER_GOAL_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker History Item
>
> **Slug:** `WORKDAY_GET_WORKER_HISTORY_ITEM`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker. Can be obtained from actions like 'Get Current User' or 'List Workers'.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the history item subresource. Can be obtained from the 'Get History Items for Worker' action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Leave Of Absence
>
> **Slug:** `WORKDAY_GET_WORKER_LEAVE_OF_ABSENCE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker, or the literal 'me' to refer to the authenticated user.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the leave-of-absence event. Obtain from Get Worker Leaves Of Absence.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Leaves of Absence
>
> **Slug:** `WORKDAY_GET_WORKER_LEAVES_OF_ABSENCE`
>
> Retrieves the Leaves Of Absence for the specified worker using the working absenceManagement v1 API.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **status** `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.
>
> **toDate** `string`
>
> The end of a date range filter using the yyyy-mm-dd format.
>
> **fromDate** `string`
>
> The start of a date range filter using the yyyy-mm-dd format.
>
> **leaveType** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Manager
>
> **Slug:** `WORKDAY_GET_WORKER_MANAGER`
>
> Resolve 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
>
> **worker\_id** `string` *required*
>
> Worker WID, Employee\_ID= value, or Contingent\_Worker\_ID= value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Organization
>
> **Slug:** `WORKDAY_GET_WORKER_ORGANIZATION`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the organization subresource (worker organization assignment).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Reports
>
> **Slug:** `WORKDAY_GET_WORKER_REPORTS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Example: '00000000000000000000000000000000'
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Requested Feedback On Self Event By Id
>
> **Slug:** `WORKDAY_GET_WORKER_REQUESTED_FEEDBACK_ON_SELF_EVENT_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Requested Feedback On Worker Event By Id
>
> **Slug:** `WORKDAY_GET_WORKER_REQUESTED_FEEDBACK_ON_WORKER_EVENT_BY_ID`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workers Compensation Code Overrides
>
> **Slug:** `WORKDAY_GET_WORKERS_COMPENSATION_CODE_OVERRIDES`
>
> Retrieves workers' compensation code override instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Service Date
>
> **Slug:** `WORKDAY_GET_WORKER_SERVICE_DATE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Can be obtained from 'List Workers' or 'Get Current User' actions.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the service date subresource. Can be obtained from the 'Get Worker Service Dates' action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workers in Supervisory Organization
>
> **Slug:** `WORKDAY_GET_WORKERS_IN_SUPERVISORY_ORG`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the supervisory organization. Use the Get Supervisory Organization Values action to find valid IDs.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Skill Item
>
> **Slug:** `WORKDAY_GET_WORKER_SKILL_ITEM`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the skill item to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Skill Items
>
> **Slug:** `WORKDAY_GET_WORKER_SKILL_ITEMS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. This is a unique identifier for the worker, typically a 32-character alphanumeric string.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Stock Plan Assignments
>
> **Slug:** `WORKDAY_GET_WORKER_STOCK_PLAN_ASSIGNMENTS`
>
> Retrieve 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
>
> **worker\_id** `string` *required*
>
> Worker identifier to place in the mandatory Worker\_Reference.
>
> **worker\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Official Workday WorkerObject identifier type for worker\_id.
>
> **as\_of\_effective\_date** `string`
>
> Effective date for the worker's current compensation data.
>
> **as\_of\_entry\_datetime** `string`
>
> Entry moment for the worker's current compensation data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Time Off Detail
>
> **Slug:** `WORKDAY_GET_WORKER_TIME_OFF_DETAIL`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Can be obtained from 'Get Current User' or 'List Workers' actions.
>
> **subresourceID** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Time Off Details
>
> **Slug:** `WORKDAY_GET_WORKER_TIME_OFF_DETAILS`
>
> Retrieves a collection of time off details for the specified worker.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **status** `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.
>
> **toDate** `string`
>
> The end of a date range filter using the yyyy-mm-dd format.
>
> **fromDate** `string`
>
> The start of a date range filter using the yyyy-mm-dd format.
>
> **timeOffType** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Types
>
> **Slug:** `WORKDAY_GET_WORKER_TYPES`
>
> Retrieves worker types instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Valid Time Off Dates
>
> **Slug:** `WORKDAY_GET_WORKER_VALID_TIME_OFF_DATES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource.
>
> **date** `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.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **timeOff** `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).
>
> **position** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Shifts
>
> **Slug:** `WORKDAY_GET_WORK_SHIFTS`
>
> Retrieves work shift instances that can be used as values for other endpoint parameters in the Workday Staffing service (Job Changes group).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace Instances
>
> **Slug:** `WORKDAY_GET_WORKSPACE_INSTANCES`
>
> Retrieves work spaces instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Work Study Awards
>
> **Slug:** `WORKDAY_GET_WORK_STUDY_AWARDS`
>
> Retrieves work study awards instances that can be used as values for other endpoint parameters in the Workday Staffing service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WQL Data Source
>
> **Slug:** `WORKDAY_GET_WQL_DATA_SOURCE`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the WQL data source to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WQL Data Source Field
>
> **Slug:** `WORKDAY_GET_WQL_DATA_SOURCE_FIELD`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the data source.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the field subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WQL Data Source Filter
>
> **Slug:** `WORKDAY_GET_WQL_DATA_SOURCE_FILTER`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the data source.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the data source filter subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Give Feedback
>
> **Slug:** `WORKDAY_GIVE_FEEDBACK`
>
> Adds a new anytime feedback event for one or more workers in Workday Talent.
>
> #### Input Parameters
>
> **comment** `string` *required*
>
> Rich text feedback comment to submit.
>
> **private** `boolean`
>
> Whether the feedback is private. Workday does not allow this to be true when confidential is true or when feedback has multiple recipients.
>
> **badge\_id** `string`
>
> Optional Workday feedback badge identifier.
>
> **show\_name** `boolean`
>
> Whether the feedback giver's name should be displayed. Defaults to true because many Workday tenants disable anonymous anytime feedback.
>
> **confidential** `boolean`
>
> Whether the feedback is confidential. Workday does not allow this to be true when private is true or when feedback has multiple recipients.
>
> **badge\_id\_type** `string`
>
> Workday identifier type for badge\_id.
>
> **to\_worker\_ids** `array` *required*
>
> Identifiers for one or more workers receiving the feedback.
>
> **from\_worker\_id** `string` *required*
>
> Identifier for the worker giving the feedback.
>
> **to\_worker\_id\_type** `string`
>
> Workday identifier type for each to\_worker\_ids value, for example WID or Employee\_ID.
>
> **feedback\_given\_date** `string`
>
> Optional dateTime when feedback was given. Workday rejects future values. Example: 2026-07-08T09:30:00.
>
> **from\_worker\_id\_type** `string`
>
> Workday identifier type for from\_worker\_id, for example WID or Employee\_ID.
>
> **business\_process\_parameters** `object`
>
> Optional Workday Business\_Process\_Parameters object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import Employee Reviews
>
> **Slug:** `WORKDAY_IMPORT_EMPLOYEE_REVIEWS`
>
> Bulk-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
>
> **employee\_reviews** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Initiate Home Contact Information Change
>
> **Slug:** `WORKDAY_INITIATE_HOME_CONTACT_INFORMATION_CHANGE`
>
> Initiate 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
>
> **worker\_id** `string` *required*
>
> Workday worker ID for whom to initiate the Home Contact Change event.
>
> **descriptor** `string`
>
> Optional display-name override for the Home Contact Change event.
>
> **effective\_date** `string` *required*
>
> Date on which the home-contact changes take effect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Initiate Work Contact Information Change
>
> **Slug:** `WORKDAY_INITIATE_WORK_CONTACT_INFORMATION_CHANGE`
>
> Creates 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **descriptor** `string`
>
> Optional display-name override for the change instance.
>
> **effective\_date** `string`
>
> The date this business process takes effect (YYYY-MM-DD).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Initiate Worker Organization Assignment Change
>
> **Slug:** `WORKDAY_INITIATE_WORKER_ORGANIZATION_ASSIGNMENT_CHANGE`
>
> Initiates 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker.
>
> **date** `string` *required*
>
> The date this business process takes effect (YYYY-MM-DD). Required by Workday.
>
> **position** `object`
>
> Position reference for the assignment change.
>
> **descriptor** `string`
>
> Optional display-name override for the change instance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Absence Balances
>
> **Slug:** `WORKDAY_LIST_ABSENCE_BALANCES`
>
> Retrieves absence balances for time off plans and leave of absence types. Can be filtered by worker ID, category, and effective date.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of balance records to return per page (1-100). Default is 20.
>
> **offset** `integer`
>
> Zero-based index for pagination. Use with limit to page through results. Default is 0.
>
> **worker** `string`
>
> The Workday ID of the worker to retrieve balances for. If not specified, returns balances for all workers.
>
> **category** `string`
>
> Filter by Workday ID of a specific Time Off Plan, Leave Type, or Absence Table category.
>
> **effective** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Absence Management Workers
>
> **Slug:** `WORKDAY_LIST_ABSENCE_MANAGEMENT_WORKERS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. Default 20, maximum 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Default 0.
>
> **search** `string`
>
> Searches workers by name or worker ID. The search is case-insensitive. Space-delimited tokens can be used to widen the match.
>
> **filterByOrgVisibility** `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.
>
> **includeTerminatedWorkers** `boolean`
>
> Include terminated workers in the output. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Active Marital Statuses
>
> **Slug:** `WORKDAY_LIST_ACTIVE_MARITAL_STATUSES`
>
> Marital 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Active Tasks
>
> **Slug:** `WORKDAY_LIST_ACTIVE_TASKS`
>
> Returns the active tasks running in the Workday system, with pagination support. Use for monitoring task throughput, queue depth, and CPU/memory consumption.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response collection. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Active User Sessions
>
> **Slug:** `WORKDAY_LIST_ACTIVE_USER_SESSIONS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Activity Logging
>
> **Slug:** `WORKDAY_LIST_ACTIVITY_LOGGING`
>
> Retrieves 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
>
> **to** `string`
>
> (Required) Date and time of the latest log entry. Format: "\{yyyy}-\{mm}-\{dd}T\{hh}:\{mm}:\{ss}.\{sss}Z" (default UTC).
>
> **from** `string`
>
> (Required) Date and time of the earliest log entry. Format: "\{yyyy}-\{mm}-\{dd}T\{hh}:\{mm}:\{ss}.\{sss}Z" (default UTC).
>
> **limit** `integer`
>
> Maximum number of objects in a single response (default 20, max 100). For activity logging the recommended max is 1000.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response collection.
>
> **taskId** `string`
>
> Filter by task ID.
>
> **systemAccount** `string`
>
> Filter by system account.
>
> **instancesReturned** `number`
>
> Multiplier (x 10,000) for total requested user activity instances. Example: 5 = 50,000.
>
> **returnUserActivityEntryCount** `boolean`
>
> If true, return only the total count of activity instances for the specified parameters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Allowed Personal Information Countries
>
> **Slug:** `WORKDAY_LIST_ALLOWED_PERSONAL_INFORMATION_COUNTRIES`
>
> The 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attendance Status Values
>
> **Slug:** `WORKDAY_LIST_ATTENDANCE_STATUS_VALUES`
>
> Retrieves attendance status instances usable as values for the attendanceStatus field on lesson tracking and enrollment endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Balances
>
> **Slug:** `WORKDAY_LIST_BALANCES`
>
> Retrieves the balance of all absence plan and leave of absence type for the specified worker ID.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of balance records to return in a single response. Default is 20, maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first record to return. Default is 0. Use with limit for pagination.
>
> **worker** `string`
>
> The Workday ID of the worker whose balances should be returned. If not specified, returns balances for all accessible workers.
>
> **category** `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.
>
> **effective** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Process Event Comments
>
> **Slug:** `WORKDAY_LIST_BUSINESS_PROCESS_EVENT_COMMENTS`
>
> Retrieves a collection of comment references for the specified business process event, including available IDs, descriptors, and resource URLs. Supports pagination.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the business process event whose comments are to be retrieved.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Process Event Remaining Steps
>
> **Slug:** `WORKDAY_LIST_BUSINESS_PROCESS_EVENT_REMAINING_STEPS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event whose remaining steps are to be retrieved.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Process Events
>
> **Slug:** `WORKDAY_LIST_BUSINESS_PROCESS_EVENTS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.
>
> **status** `array`
>
> Filter by one or more event status Workday IDs (e.g., InProgress, Completed). Repeat the query parameter for each value.
>
> **worker** `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.
>
> **initiator** `array`
>
> Filter by one or more initiator (worker) Workday IDs. Repeat the query parameter for each value.
>
> **businessProcess** `array`
>
> Filter by one or more business process type Workday IDs. Repeat the query parameter for each value.
>
> **completedOnOrAfter** `string`
>
> Return events completed on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> **initiatedOnOrAfter** `string`
>
> Return events initiated on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> **completedOnOrBefore** `string`
>
> Return events completed on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> **initiatedOnOrBefore** `string`
>
> Return events initiated on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Process Event Steps
>
> **Slug:** `WORKDAY_LIST_BUSINESS_PROCESS_EVENT_STEPS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.
>
> **stepType** `array`
>
> Filter by one or more step type Workday IDs (e.g., Approval, ToDo, Questionnaire). Repeat the query parameter for each value.
>
> **businessProcess** `array`
>
> Filter by one or more business process type Workday IDs. Repeat the query parameter for each value.
>
> **createdOnOrAfter** `string`
>
> Return event steps created on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> **dueDateOnOrAfter** `string`
>
> Return event steps due on or after this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> **createdOnOrBefore** `string`
>
> Return event steps created on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> **dueDateOnOrBefore** `string`
>
> Return event steps due on or before this date (yyyy-MM-dd or full ISO 8601 timestamp).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Process Type Attachment Categories
>
> **Slug:** `WORKDAY_LIST_BUSINESS_PROCESS_TYPE_ATTACHMENT_CATEGORIES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process type whose attachment categories are to be retrieved.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0. Use with limit to page through results.
>
> **eventTarget** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Business Process Types
>
> **Slug:** `WORKDAY_LIST_BUSINESS_PROCESS_TYPES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Cascade Goal Talent Pools
>
> **Slug:** `WORKDAY_LIST_CASCADE_GOAL_TALENT_POOLS`
>
> Talent 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Case Types
>
> **Slug:** `WORKDAY_LIST_CASE_TYPES`
>
> Return 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
>
> **limit** `integer`
>
> Maximum case types to return, from 1 through 100.
>
> **offset** `integer`
>
> Zero-based result offset.
>
> **worker** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Compensation Plans
>
> **Slug:** `WORKDAY_LIST_COMPENSATION_PLANS`
>
> Retrieve detailed compensation plans with the official Workday Compensation v46.0 Get\_Compensation\_Plans SOAP operation.
>
> #### Input Parameters
>
> **page** `integer`
>
> One-based page number. Pages after page 1 require as\_of\_entry\_datetime.
>
> **count** `integer`
>
> Number of compensation plans to return per page, from 1 through 999.
>
> **include\_inactive** `boolean`
>
> Whether to include inactive compensation plans and guideline components.
>
> **as\_of\_effective\_date** `string`
>
> Effective date for application data. Workday defaults to today.
>
> **as\_of\_entry\_datetime** `string`
>
> Entry timestamp for the result set. Reuse it across pages to keep paginated results stable.
>
> **plan\_type\_references** `array`
>
> Optional official compensation plan type criteria or Workday WIDs.
>
> **compensation\_plan\_references** `array`
>
> Specific compensation plans to retrieve. Do not combine with plan type criteria or include\_inactive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Compensation Workers
>
> **Slug:** `WORKDAY_LIST_COMPENSATION_WORKERS`
>
> Lists 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **search** `string`
>
> Case-insensitive substring search across worker names. Use to narrow the list when you know part of the worker's display name.
>
> **includeTerminatedWorkers** `boolean`
>
> Include terminated workers in the output. Defaults to false in Workday when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Countries
>
> **Slug:** `WORKDAY_LIST_COUNTRIES`
>
> Retrieves country instance references that can be used as values for other recruiting endpoint parameters. Prompt Values endpoint under the recruiting service.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Country Components Country
>
> **Slug:** `WORKDAY_LIST_COUNTRY_COMPONENTS_COUNTRY`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Country Components Country City
>
> **Slug:** `WORKDAY_LIST_COUNTRY_COMPONENTS_COUNTRY_CITY`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Country Components Country Region
>
> **Slug:** `WORKDAY_LIST_COUNTRY_COMPONENTS_COUNTRY_REGION`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Country Phone Codes
>
> **Slug:** `WORKDAY_LIST_COUNTRY_PHONE_CODES`
>
> Exposes 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Currencies
>
> **Slug:** `WORKDAY_LIST_CURRENCIES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Field Type List Values
>
> **Slug:** `WORKDAY_LIST_CUSTOM_FIELD_TYPE_LIST_VALUES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom field type (custom list) whose list values to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Field Types
>
> **Slug:** `WORKDAY_LIST_CUSTOM_FIELD_TYPES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **fieldType** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Definition Condition Rules
>
> **Slug:** `WORKDAY_LIST_CUSTOM_OBJECT_DEFINITION_CONDITION_RULES`
>
> Retrieves a page of condition rules attached to a custom object definition. Use limit and offset to enumerate rules across pages.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition whose condition rules to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Definition Fields
>
> **Slug:** `WORKDAY_LIST_CUSTOM_OBJECT_DEFINITION_FIELDS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition whose fields to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Definitions
>
> **Slug:** `WORKDAY_LIST_CUSTOM_OBJECT_DEFINITIONS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Definition Validations
>
> **Slug:** `WORKDAY_LIST_CUSTOM_OBJECT_DEFINITION_VALIDATIONS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition whose validations to retrieve.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Objects (Multi-Instance)
>
> **Slug:** `WORKDAY_LIST_CUSTOM_OBJECTS_MULTI_INSTANCE`
>
> Retrieves 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
>
> **businessObjectId** `string` *required*
>
> The Workday ID of the extended business object instance.
>
> **customObjectAlias** `string` *required*
>
> The web service alias of the custom object. Determine this by running the 'View Custom Object' task in Workday.
>
> **businessObjectResource** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Duration Unit Values
>
> **Slug:** `WORKDAY_LIST_DURATION_UNIT_VALUES`
>
> Retrieves duration unit instances usable as values for the duration field on lesson tracking and enrollment endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Enrollment Events
>
> **Slug:** `WORKDAY_LIST_EMPLOYEE_ENROLLMENT_EVENTS`
>
> Retrieves 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
>
> **planType** `string`
>
> Benefit Election or Plan Type (e.g., "Healthcare", "Retirement Savings").
>
> **onlyCurrentElections** `boolean`
>
> If true, return only the current active enrollment offerings of the processing worker.
>
> **enrollmentOfferingTypeWID** `string`
>
> WID of Enrollment Offering Type (e.g., Medical, Dental, Vision, 401(k), Basic Group Life).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Expense Entries
>
> **Slug:** `WORKDAY_LIST_EXPENSE_ENTRIES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Use offset with limit to page through results.
>
> **toDate** `string`
>
> Latest entry date to include in results (YYYY-MM-DD).
>
> **fromDate** `string`
>
> Earliest entry date to include in results (YYYY-MM-DD).
>
> **entryType** `string`
>
> Filter entries by their class type (Workday ID of the entry type, e.g. 'Quick Expense', 'Credit Card Transaction').
>
> **expenseEntryStatus** `string`
>
> Filter entries by status (Workday ID of the expense entry status instance).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Expense Items
>
> **Slug:** `WORKDAY_LIST_EXPENSE_ITEMS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Use offset with limit to page through results.
>
> **searchString** `string`
>
> Case-insensitive substring filter applied to the expense item name.
>
> **disallowFixedItems** `boolean`
>
> If true, exclude fixed-amount expense items (e.g. per-diem items) from the results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Expense Reports
>
> **Slug:** `WORKDAY_LIST_EXPENSE_REPORTS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **toDate** `string`
>
> Filter expense reports created on or before this date (YYYY-MM-DD).
>
> **fromDate** `string`
>
> Filter expense reports created on or after this date (YYYY-MM-DD).
>
> **expenseReportMemo** `string`
>
> Filter expense reports by memo (substring match).
>
> **expenseReportStatus** `array`
>
> Filter expense reports by one or more status WIDs. Repeat the query parameter to filter on multiple statuses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Federal W-4 Elections
>
> **Slug:** `WORKDAY_LIST_FEDERAL_W4_ELECTIONS`
>
> List 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
>
> **page** `integer`
>
> One-based Workday response page number.
>
> **count** `integer`
>
> Number of elections to return, from 1 through 999.
>
> **w4\_references** `array`
>
> One or more federal W-4 tax election references. Use this selector or worker\_references, but not both.
>
> **effective\_as\_of** `string`
>
> Optional effective date criterion. If supplied, Workday returns the election in effect on this date.
>
> **company\_reference** `object`
>
> Optional company criterion used with worker\_references. If omitted, elections for every company associated with each worker are returned.
>
> **include\_reference** `boolean`
>
> Whether Workday should include election references in the response.
>
> **worker\_references** `array`
>
> One or more workers whose federal W-4 elections should be returned. Use this selector or w4\_references, but not both.
>
> **as\_of\_effective\_date** `string`
>
> Optional Workday response effective-moment date.
>
> **as\_of\_entry\_datetime** `string`
>
> Optional Workday response entry moment. Supply this when paging to keep the result set stable between requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Feedback Badges
>
> **Slug:** `WORKDAY_LIST_FEEDBACK_BADGES`
>
> Retrieves a collection of active Feedback Badges. Use when you need to read this Workday data via the Performance Enablement REST API.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Feedback On Worker Values
>
> **Slug:** `WORKDAY_LIST_FEEDBACK_ON_WORKER_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Feedback Responder Values
>
> **Slug:** `WORKDAY_LIST_FEEDBACK_RESPONDER_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Feedback Template Values
>
> **Slug:** `WORKDAY_LIST_FEEDBACK_TEMPLATE_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Give Requested Feedback Events
>
> **Slug:** `WORKDAY_LIST_GIVE_REQUESTED_FEEDBACK_EVENTS`
>
> Retrieves a page of requested feedback events through the Workday Performance Enablement API. Each returned item exposes its ID, descriptor, and link.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Grade Values
>
> **Slug:** `WORKDAY_LIST_GRADE_VALUES`
>
> Retrieves grade instances usable as values for the grade field on lesson tracking and enrollment endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Graph API Versions
>
> **Slug:** `WORKDAY_LIST_GRAPH_API_VERSIONS`
>
> Retrieves 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
>
> **includeTest** `boolean`
>
> For Internal Use Only. Whether to include test versions in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Help Case Configurations
>
> **Slug:** `WORKDAY_LIST_HELP_CASE_CONFIGURATIONS`
>
> Retrieves tenant setup configurations related to Help Case Management. Configuration details include confidential case message, file configurations, and maximum number of attachments.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of objects to return. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Home Contact Change Addresses
>
> **Slug:** `WORKDAY_LIST_HOME_CONTACT_CHANGE_ADDRESSES`
>
> Return 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
>
> **limit** `integer`
>
> Maximum number of staged addresses to return (1-100).
>
> **offset** `integer`
>
> Zero-based index of the first staged address to return.
>
> **event\_id** `string` *required*
>
> Home Contact Change event ID returned by the initiate tool.
>
> **used\_for** `string`
>
> Optional Workday usage value by which to filter staged addresses.
>
> **primary\_only** `boolean`
>
> When set, return only primary addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interviews
>
> **Slug:** `WORKDAY_LIST_INTERVIEWS`
>
> Retrieves a list of interviews with job requisition and recruiter assignment details. Supports filtering by status for pipeline review and scheduled interviews.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **interviewStatus** `array`
>
> All applicable interview statuses for an Interview event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Change Reasons
>
> **Slug:** `WORKDAY_LIST_JOB_CHANGE_REASONS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Use offset with the limit parameter to control paging.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Families
>
> **Slug:** `WORKDAY_LIST_JOB_FAMILIES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> **inactive** `boolean`
>
> If true, the method returns inactive job families. Default is false.
>
> **jobProfile** `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.
>
> **jobFamilyGroup** `array`
>
> The job family group for the job family. You can specify more than 1 jobFamilyGroup query parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Posting Filter Values
>
> **Slug:** `WORKDAY_LIST_JOB_POSTING_FILTER_VALUES`
>
> Return 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
>
> **page** `integer`
>
> One-based Workday page to return.
>
> **count** `integer`
>
> Maximum filter values to return on this page, from 1 through 100.
>
> **as\_of\_entry\_datetime** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Postings
>
> **Slug:** `WORKDAY_LIST_JOB_POSTINGS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **jobSite** `array`
>
> Filter job postings by job site IDs. Allows filtering by the sites/locations where jobs are posted.
>
> **category** `array`
>
> Filter job postings by category IDs. Allows filtering by one or more job categories/classifications.
>
> **jobPosting** `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.
>
> **jobRequisition** `array`
>
> Job Requisition for Job Posting Anchor
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Profiles
>
> **Slug:** `WORKDAY_LIST_JOB_PROFILES`
>
> Retrieves a collection of job profiles from the Workday Staffing service. Supports filtering by active/inactive state and pagination via limit/offset.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. The default is 0.
>
> **includeInactive** `boolean`
>
> If true, the method returns inactive job profiles. Default is false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Jobs
>
> **Slug:** `WORKDAY_LIST_JOBS`
>
> Retrieves a collection of jobs from Workday Staffing system. Use this to get current staffing information including job positions, workers, and organizational details.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Learning Content
>
> **Slug:** `WORKDAY_LIST_LEARNING_CONTENT`
>
> Retrieves a collection of learning content items including programs, courses, course offerings, and other content types supported by the Workday Learning catalog.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of objects to return. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based offset of the first object in the response.
>
> **skills** `array`
>
> Filter by skills associated with the learning content.
>
> **topics** `array`
>
> Filter by topic groups that the learning content belongs to.
>
> **contentType** `array`
>
> The type of learning content (programs, blended/digital courses, offerings, etc.).
>
> **lastUpdated** `string`
>
> When specified, only learning content updated since this datetime is returned (ISO 8601).
>
> **lifecycleStatus** `array`
>
> The current status of the learning content (Active or Inactive).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Learning Content Lessons
>
> **Slug:** `WORKDAY_LIST_LEARNING_CONTENT_LESSONS`
>
> Retrieves a page of lessons for a learning content item, with limit and offset pagination.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the learning content.
>
> **limit** `integer`
>
> Maximum number of objects to return. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based offset of the first object in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Learning Records
>
> **Slug:** `WORKDAY_LIST_LEARNING_RECORDS`
>
> Retrieves a collection of learning records with filters for completion status, content, expiration window, learner, lifecycle status, and record type.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of objects to return. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based offset of the first object in the response.
>
> **content** `array`
>
> Filter by learning content reference.
>
> **learner** `string`
>
> Filter by learning participant (worker reference).
>
> **recordType** `array`
>
> Filter by learning record type.
>
> **lastUpdated** `string`
>
> Filter by last-updated datetime.
>
> **lifecycleStatus** `array`
>
> Filter by lifecycle status.
>
> **completionStatus** `array`
>
> Filter by record completion status.
>
> **expirationDateAfter** `string`
>
> Filter by expiration date after this date.
>
> **expirationDateBeforeOrOn** `string`
>
> Filter by expiration date on or before this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Manage Goals Categories
>
> **Slug:** `WORKDAY_LIST_MANAGE_GOALS_CATEGORIES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Manage Goals Status
>
> **Slug:** `WORKDAY_LIST_MANAGE_GOALS_STATUS`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Mentorships
>
> **Slug:** `WORKDAY_LIST_MENTORSHIPS`
>
> Returns mentorships viewable by the authenticated user. Supports filtering by mentor, mentee, mentor type, close reason, and lifecycle state (closed / in-progress).
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default is 20, maximum is 100.
>
> **closed** `boolean`
>
> Filter by closed state (true returns closed mentorships).
>
> **mentee** `array`
>
> Filter by mentee worker instance IDs.
>
> **mentor** `array`
>
> Filter by mentor worker instance IDs.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **inProgress** `boolean`
>
> Filter by in-progress state (true returns mentorships with an in-progress event).
>
> **mentorType** `array`
>
> Filter by mentor type instance IDs.
>
> **closeMentorshipReason** `array`
>
> Filter by close mentorship reason instance IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Message Templates
>
> **Slug:** `WORKDAY_LIST_MESSAGE_TEMPLATES`
>
> Retrieves 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
>
> **name** `string`
>
> Filter results to message templates whose name contains this string (case-insensitive substring match).
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Use offset with limit to page through results.
>
> **inactive** `boolean`
>
> If true, also include inactive (disabled) message templates in the response.
>
> **notificationType** `string`
>
> Filter results to message templates that target this notification type, by its Workday ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Minimum Wage Rates
>
> **Slug:** `WORKDAY_LIST_MINIMUM_WAGE_RATES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **country** `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.
>
> **asOfDate** `string`
>
> The effective date for the minimum wage rates, using the date format yyyy-mm-dd.
>
> **taxAuthority** `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.
>
> **includeLocalTaxAuthorities** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Academic
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_ACADEMIC`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Hereditary
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_HEREDITARY`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Honorary
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_HONORARY`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Professional
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_PROFESSIONAL`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Religious
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_RELIGIOUS`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Royal
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_ROYAL`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Salutation
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_SALUTATION`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Social
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_SOCIAL`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Name Components Title
>
> **Slug:** `WORKDAY_LIST_NAME_COMPONENTS_TITLE`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Notification Types
>
> **Slug:** `WORKDAY_LIST_NOTIFICATION_TYPES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List OAuth Client Details
>
> **Slug:** `WORKDAY_LIST_O_AUTH_CLIENT_DETAILS`
>
> Returns 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
>
> **client\_name** `string`
>
> Filter by client name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List One-Time Payment Plans
>
> **Slug:** `WORKDAY_LIST_ONE_TIME_PAYMENT_PLANS`
>
> Retrieve 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
>
> **page** `integer`
>
> One-based Workday result page.
>
> **count** `integer`
>
> Number of plans to return, from 1 through 999.
>
> **plan\_references** `array`
>
> Specific one-time payment plans to retrieve. Do not combine with include\_inactive.
>
> **include\_inactive** `boolean`
>
> Whether to include inactive one-time payment plans.
>
> **as\_of\_effective\_date** `string`
>
> Effective date for plan configuration. Workday defaults to today.
>
> **as\_of\_entry\_datetime** `string`
>
> Stable entry timestamp to reuse when retrieving later pages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List One-Time Payment Reason Candidates
>
> **Slug:** `WORKDAY_LIST_ONE_TIME_PAYMENT_REASON_CANDIDATES`
>
> List 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
>
> **page** `integer`
>
> One-based Workday page, capped at 100.
>
> **count** `integer`
>
> Maximum candidates requested on this single page, from 1 through 100. This tool does not fetch subsequent pages automatically.
>
> **as\_of\_entry\_datetime** `string`
>
> Stable Workday entry timestamp. Reuse the returned value for later pages; required when page is greater than 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organization Goal Goal Periods
>
> **Slug:** `WORKDAY_LIST_ORGANIZATION_GOAL_GOAL_PERIODS`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organization Goal Organizations
>
> **Slug:** `WORKDAY_LIST_ORGANIZATION_GOAL_ORGANIZATIONS`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organization Goal Supporting Initiatives
>
> **Slug:** `WORKDAY_LIST_ORGANIZATION_GOAL_SUPPORTING_INITIATIVES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organizations 2
>
> **Slug:** `WORKDAY_LIST_ORGANIZATIONS2`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Use offset with the limit parameter to control paging.
>
> **organizationType** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organization Types
>
> **Slug:** `WORKDAY_LIST_ORGANIZATION_TYPES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 25. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pay Group Details
>
> **Slug:** `WORKDAY_LIST_PAY_GROUP_DETAILS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **runCategories** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pay Groups
>
> **Slug:** `WORKDAY_LIST_PAY_GROUPS`
>
> Retrieves a collection of pay groups. Inactive and External Pay Groups are not supported.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **country** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Election Enrollments
>
> **Slug:** `WORKDAY_LIST_PAYMENT_ELECTION_ENROLLMENTS`
>
> Retrieve 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
>
> **page** `integer`
>
> One-based page number. Pages after page 1 require as\_of\_entry\_datetime.
>
> **count** `integer`
>
> Number of enrollment records to return in this page, from 1 through 999.
>
> **include\_reference** `boolean`
>
> Whether Workday should include enrollment references in the response.
>
> **include\_all\_people** `boolean`
>
> Deprecated compatibility field. Only false is accepted and it is not sent to Workday; enrollment\_references remain required.
>
> **as\_of\_effective\_date** `string`
>
> Effective date for the returned application data; Workday defaults to today.
>
> **as\_of\_entry\_datetime** `string`
>
> Entry moment for the result set. Keep this value unchanged across pages to obtain a stable paginated result set.
>
> **enrollment\_references** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payroll Interface Pay Group Periods
>
> **Slug:** `WORKDAY_LIST_PAYROLL_INTERFACE_PAY_GROUP_PERIODS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the pay group.
>
> **limit** `integer`
>
> Maximum number of objects in a single response (default 20, max 100).
>
> **offset** `integer`
>
> Zero-based index of the first object in the response collection.
>
> **periodEndDate** `string`
>
> Filter to a specific pay period end date (yyyy-mm-dd). Not compatible with showMostRecentOnly.
>
> **showMostRecentOnly** `boolean`
>
> If true, return only the 5 most recent pay periods. Not compatible with periodEndDate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payroll Interface Pay Groups
>
> **Slug:** `WORKDAY_LIST_PAYROLL_INTERFACE_PAY_GROUPS`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response (default 20, max 100).
>
> **offset** `integer`
>
> Zero-based index of the first object in the response collection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payroll Jobs
>
> **Slug:** `WORKDAY_LIST_PAYROLL_JOBS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payroll Results
>
> **Slug:** `WORKDAY_LIST_PAYROLL_RESULTS`
>
> Lists 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
>
> **page** `integer`
>
> One-based Workday result page.
>
> **count** `integer`
>
> Maximum payroll results in this page.
>
> **selector** `string` *required*
>
> Choose one payroll-result selector: explicit payroll result references or date-based criteria.
>
> **include\_qtd\_data** `boolean`
>
> Include quarter-to-date amounts in payroll result detail.
>
> **include\_ytd\_data** `boolean`
>
> Include year-to-date amounts in payroll result detail.
>
> **include\_name\_data** `boolean`
>
> Include worker name data in payroll results.
>
> **as\_of\_entry\_datetime** `string`
>
> Entry moment for the result set. Keep this value unchanged across pages; it is required after the first page.
>
> **include\_national\_id\_data** `boolean`
>
> Include worker national ID data in payroll results.
>
> **include\_payroll\_worktag\_data** `boolean`
>
> Include payroll worktag data in payroll results.
>
> **include\_withholding\_order\_data** `boolean`
>
> Include withholding order data in payroll results.
>
> **include\_related\_calculation\_result\_data** `boolean`
>
> Include related calculation result detail for earning and deduction lines.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List People
>
> **Slug:** `WORKDAY_LIST_PEOPLE`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **search** `string`
>
> Searches people by name or person ID. The search is case-insensitive.
>
> **includeTerminatedWorkers** `boolean`
>
> Include terminated workers in the output. When true, the response will include workers who have been terminated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Performance Workers
>
> **Slug:** `WORKDAY_LIST_PERFORMANCE_WORKERS`
>
> Lists 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **search** `string`
>
> Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.
>
> **filterByOrgVisibility** `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.
>
> **includeTerminatedWorkers** `boolean`
>
> Include terminated workers in the output
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Period Schedules
>
> **Slug:** `WORKDAY_LIST_PERIOD_SCHEDULES`
>
> Retrieve Workday Payroll period schedules and their period details.
>
> #### Input Parameters
>
> **page** `integer`
>
> One-based page number. Workday defaults to page 1.
>
> **count** `integer`
>
> Number of period schedules to return, from 1 through 999.
>
> **as\_of\_effective\_date** `string`
>
> Effective date for the returned application data. Workday defaults to today.
>
> **as\_of\_entry\_datetime** `string`
>
> Entry date and time for the result set. Supply the same value on later pages to keep paginated results stable.
>
> **period\_schedule\_references** `array`
>
> Optional period schedule references. Omit to retrieve period schedules broadly.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Populated Personal Information Countries
>
> **Slug:** `WORKDAY_LIST_POPULATED_PERSONAL_INFORMATION_COUNTRIES`
>
> The 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Referral Requisition Candidates
>
> **Slug:** `WORKDAY_LIST_REFERRAL_REQUISITION_CANDIDATES`
>
> Return 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
>
> **page** `integer`
>
> One-based Workday page to return, bounded from 1 through 100.
>
> **count** `integer`
>
> Maximum active postings to inspect on this page, from 1 through 100.
>
> **as\_of\_effective\_date** `string`
>
> Optional effective date for active job postings.
>
> **as\_of\_entry\_datetime** `string`
>
> Stable entry timestamp. Required after page 1 and reused across pages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Relates To Values
>
> **Slug:** `WORKDAY_LIST_RELATES_TO_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Requests
>
> **Slug:** `WORKDAY_LIST_REQUESTS`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response. Default 0.
>
> **initiator** `array`
>
> WIDs of the persons who initiated the request(s). Multiple values supported.
>
> **requestId** `string`
>
> Request ID (per the ID generator format).
>
> **onBehalfOf** `string`
>
> Workday ID of the person the request was initiated on behalf of.
>
> **resolution** `array`
>
> Workday IDs of resolution. Multiple values supported. Valid values: 00000000000000000000000000000104 (Done), 00000000000000000000000000000108 (Duplicate), 00000000000000000000000000000109 (Denied), 00000000000000000000000000000107 (Canceled).
>
> **requestType** `array`
>
> Workday IDs of request types. Multiple values supported.
>
> **requestSubtype** `array`
>
> Workday IDs of request subtypes. Multiple values supported.
>
> **resolutionDetails** `array`
>
> Workday IDs of resolution details. Multiple values supported.
>
> **completedOnOrAfter** `string`
>
> Return only requests completed on or after this date (YYYY-MM-DD).
>
> **initiatedOnOrAfter** `string`
>
> Return only requests initiated on or after this date (YYYY-MM-DD).
>
> **workdayObjectValue** `array`
>
> Workday IDs of the business object associated with the request.
>
> **completedOnOrBefore** `string`
>
> Return only requests completed on or before this date (YYYY-MM-DD).
>
> **initiatedOnOrBefore** `string`
>
> Return only requests initiated on or before this date (YYYY-MM-DD).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Request Types
>
> **Slug:** `WORKDAY_LIST_REQUEST_TYPES`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response. Default 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Requisition Templates
>
> **Slug:** `WORKDAY_LIST_REQUISITION_TEMPLATES`
>
> Retrieves a paginated collection of requisition templates. Use to power template pickers or to enumerate reusable requisition starting points.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of templates to return. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based offset for pagination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Scorecard Results
>
> **Slug:** `WORKDAY_LIST_SCORECARD_RESULTS`
>
> Lists 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Send Back To Values
>
> **Slug:** `WORKDAY_LIST_SEND_BACK_TO_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Succession Plan Events
>
> **Slug:** `WORKDAY_LIST_SUCCESSION_PLAN_EVENTS`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default is 20, maximum is 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **successionPlan** `string`
>
> The succession plan instance ID. You must specify a succession plan ID to retrieve related events; otherwise the response is blank.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Succession Plan Member Values
>
> **Slug:** `WORKDAY_LIST_SUCCESSION_PLAN_MEMBER_VALUES`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default and maximum is 1000.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **search** `string`
>
> Search string matching display IDs. Case-insensitive; matches words that start with the given string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Succession Plan Readiness Values
>
> **Slug:** `WORKDAY_LIST_SUCCESSION_PLAN_READINESS_VALUES`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default and maximum is 1000.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **search** `string`
>
> Search string matching display IDs. Case-insensitive; matches words that start with the given string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Succession Plans
>
> **Slug:** `WORKDAY_LIST_SUCCESSION_PLANS`
>
> Returns 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default is 20, maximum is 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **position** `string`
>
> Position ID used to filter succession plans to a specific position.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Succession Plan Strategy Values
>
> **Slug:** `WORKDAY_LIST_SUCCESSION_PLAN_STRATEGY_VALUES`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default and maximum is 1000.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **search** `string`
>
> Search string matching display IDs. Case-insensitive; matches words that start with the given string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Supervisory Organizations
>
> **Slug:** `WORKDAY_LIST_SUPERVISORY_ORGANIZATIONS`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **includeInactive** `boolean`
>
> If true, this method returns the inactive organizations. Default is false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List System Metrics Overview
>
> **Slug:** `WORKDAY_LIST_SYSTEM_METRICS_OVERVIEW`
>
> Retrieves a collection of system metrics overview snapshots — queued tasks, running tasks, and active user sessions. Use for monitoring overall Workday system load.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tax Rates
>
> **Slug:** `WORKDAY_LIST_TAX_RATES`
>
> Lists 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **company** `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.
>
> **effective** `string`
>
> The effective date for the SUI rate, using the yyyy-mm-dd format.
>
> **payrollStateAuthorityTaxCode** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Template For My Performance Review
>
> **Slug:** `WORKDAY_LIST_TEMPLATE_FOR_MY_PERFORMANCE_REVIEW`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Time Clock Events
>
> **Slug:** `WORKDAY_LIST_TIME_CLOCK_EVENTS`
>
> Return 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
>
> **limit** `integer`
>
> Maximum events in this one bounded page, from 1 to 100.
>
> **offset** `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.
>
> **toDate** `string`
>
> End date, inclusive, in YYYY-MM-DD format.
>
> **worker** `array`
>
> Worker IDs to filter by. Each value is sent as a repeated worker query parameter.
>
> **fromDate** `string`
>
> Start date, inclusive, in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Time Clock Event Codes and Time Zones
>
> **Slug:** `WORKDAY_LIST_TIME_CLOCK_OPTIONS`
>
> Returns 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
>
> **date** `string` *required*
>
> Effective date used to evaluate the worker's eligible values.
>
> **limit** `integer`
>
> Maximum values in each independently bounded Workday collection, up to 1000.
>
> **offset** `integer`
>
> Zero-based offset sent to both endpoints. Each collection independently skips this many values; this is not one combined offset.
>
> **search** `string`
>
> Optional case-insensitive display-ID prefix search.
>
> **worker** `string` *required*
>
> Workday worker ID used to scope eligible time entry codes and time zones.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worked Time Options
>
> **Slug:** `WORKDAY_LIST_WORKED_TIME_OPTIONS`
>
> Return 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
>
> **date** `string` *required*
>
> Effective date used to evaluate all returned Worked Time options.
>
> **limit** `integer`
>
> Maximum references returned by each endpoint, from 1 through 1000.
>
> **offset** `integer`
>
> Zero-based offset applied independently to each endpoint.
>
> **search** `string`
>
> Optional case-insensitive display-ID prefix search applied to every collection.
>
> **worker** `string` *required*
>
> Workday worker ID used to scope all returned Worked Time options.
>
> **project\_id** `string`
>
> Optional project ID used only to filter project plan tasks to that project.
>
> **in\_out\_code\_only** `boolean`
>
> When true, return only in/out time entry codes. Omit for general Worked Time discovery.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Anytime Feedback Events
>
> **Slug:** `WORKDAY_LIST_WORKER_ANYTIME_FEEDBACK_EVENTS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Dependents
>
> **Slug:** `WORKDAY_LIST_WORKER_DEPENDENTS`
>
> Retrieve 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
>
> **page** `integer`
>
> One-based Workday response page to return. Pages after the first require as\_of\_entry\_datetime.
>
> **count** `integer`
>
> Number of Worker objects to return per page (1-999).
>
> **worker\_id** `string` *required*
>
> Worker identifier to pass in Worker\_Reference/ID.
>
> **worker\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Official Workday WorkerObject ID type used for worker\_id.
>
> **as\_of\_entry\_datetime** `string`
>
> Entry timestamp for the result set. Required after page 1 and reused across pages to keep paginated results stable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Development Items
>
> **Slug:** `WORKDAY_LIST_WORKER_DEVELOPMENT_ITEMS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Goal Events
>
> **Slug:** `WORKDAY_LIST_WORKER_GOAL_EVENTS`
>
> Get Worker Goal Events. Use when you need to read this Workday data via the Performance Enablement REST API.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Goals
>
> **Slug:** `WORKDAY_LIST_WORKER_GOALS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Inbox Tasks
>
> **Slug:** `WORKDAY_LIST_WORKER_INBOX_TASKS`
>
> Retrieves a collection of inbox tasks for a specific Workday worker.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Use `me` for the authenticated worker.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Use offset with limit to page through results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Requested Feedback On Self Events
>
> **Slug:** `WORKDAY_LIST_WORKER_REQUESTED_FEEDBACK_ON_SELF_EVENTS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workers
>
> **Slug:** `WORKDAY_LIST_WORKERS`
>
> Retrieves a collection of workers and current staffing information.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 20. The maximum is 100.
>
> **offset** `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.
>
> **search** `string`
>
> Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.
>
> **includeTerminatedWorkers** `boolean`
>
> Include terminated workers in the output
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workers (Time Tracking)
>
> **Slug:** `WORKDAY_LIST_WORKERS2`
>
> Retrieves a collection of workers and current staffing information from the Time Tracking service. Use to list workers eligible for time-tracking operations.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return. Default is 20, maximum is 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **search** `string`
>
> Search workers by name or worker ID. Case-insensitive; space-delimited search strings form an OR search.
>
> **filterByOrgVisibility** `boolean`
>
> Only return workers whose supervisory organizations are visible to the processing user.
>
> **includeTerminatedWorkers** `boolean`
>
> Include terminated workers in the output.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Service Dates
>
> **Slug:** `WORKDAY_LIST_WORKER_SERVICE_DATES`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker resource. Can be obtained from 'List Workers' or 'Get Current User' actions.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. The default is 25. The maximum is 100.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workers To Notify Values
>
> **Slug:** `WORKDAY_LIST_WORKERS_TO_NOTIFY_VALUES`
>
> Retrieves 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Time Blocks
>
> **Slug:** `WORKDAY_LIST_WORKER_TIME_BLOCKS`
>
> Retrieves 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
>
> **limit** `integer`
>
> Maximum number of objects in a single response. Default is 20, maximum is 100.
>
> **phase** `array`
>
> Filter by Workday ID of project plan phase. Multiple values allowed.
>
> **offset** `integer`
>
> Zero-based index of the first object in a response collection. Default is 0.
>
> **status** `array`
>
> Filter by approval status Workday ID. Submitted: 00000000000000000000000000000111; Unsubmitted: 00000000000000000000000000000110; Approved: 00000000000000000000000000000100; Denied: 00000000000000000000000000000106; Sent Back: 00000000000000000000000000000101.
>
> **toDate** `string`
>
> End date (YYYY-MM-DD) of the time block date range.
>
> **worker** `array`
>
> Filter by Workday ID of worker. Multiple values allowed.
>
> **project** `array`
>
> Filter by Workday ID of project. Multiple values allowed.
>
> **fromDate** `string`
>
> Start date (YYYY-MM-DD) of the time block date range.
>
> **projectPlanTask** `array`
>
> Filter by Workday ID of project plan task. Multiple values allowed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WQL Data Source Fields
>
> **Slug:** `WORKDAY_LIST_WQL_DATA_SOURCE_FIELDS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the data source whose fields to list.
>
> **alias** `string`
>
> Alias of the data source field to retrieve.
>
> **limit** `integer`
>
> Maximum number of fields in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first field in the response. Default 0.
>
> **searchString** `string`
>
> Case-insensitive search string within field descriptors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WQL Data Source Filters
>
> **Slug:** `WORKDAY_LIST_WQL_DATA_SOURCE_FILTERS`
>
> Retrieves 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
>
> **ID** `string` *required*
>
> The Workday ID of the data source whose filters to list.
>
> **alias** `string`
>
> Alias of the data source filter to retrieve.
>
> **limit** `integer`
>
> Maximum number of filters in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first filter in the response. Default 0.
>
> **searchString** `string`
>
> Case-insensitive search string within filter descriptors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List WQL Data Sources
>
> **Slug:** `WORKDAY_LIST_WQL_DATA_SOURCES`
>
> Retrieves 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
>
> **alias** `string`
>
> The alias of the data source.
>
> **limit** `integer`
>
> The maximum number of objects in a single response. Default 20, max 100.
>
> **offset** `integer`
>
> Zero-based index of the first object in the response. Default 0.
>
> **searchString** `string`
>
> Case-insensitive search string within data source descriptors.
>
> **dataSourceIndexType** `string`
>
> Filter "Indexed" and "Non-indexed" data sources.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Load Employee Reviews
>
> **Slug:** `WORKDAY_LOAD_EMPLOYEE_REVIEWS`
>
> Bulk-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
>
> **employee\_reviews** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Manage Goals
>
> **Slug:** `WORKDAY_MANAGE_GOALS`
>
> Executes manage goals in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if matching goals already exist.
>
> **manage\_goals\_data** `object` *required*
>
> Workday Manage\_Goals\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **business\_process\_parameters** `object`
>
> Optional Workday Business\_Process\_Parameters object. Use Workday SOAP element names as keys.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Case
>
> **Slug:** `WORKDAY_PATCH_CASE`
>
> Edits 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
>
> **ID** `string` *required*
>
> The Workday ID of the case to edit.
>
> **flag** `object`
>
> A simple Workday id reference.
>
> **team** `object`
>
> A simple Workday id reference.
>
> **type** `object`
>
> A simple Workday id reference.
>
> **labels** `array`
>
> Replacement list of case label references.
>
> **status** `object`
>
> A simple Workday id reference.
>
> **reroute** `boolean`
>
> Whether to reroute the case after the case type changes.
>
> **assignee** `object`
>
> A simple Workday id reference.
>
> **substatus** `object`
>
> A simple Workday id reference.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Expense Entry
>
> **Slug:** `WORKDAY_PATCH_EXPENSE_ENTRY`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the Quick Expense entry to update.
>
> **date** `string`
>
> New transaction date for the entry (YYYY-MM-DD).
>
> **memo** `string`
>
> New free-form memo for the expense entry.
>
> **image** `object`
>
> A Workday instance reference (id / descriptor / href).
>
> **amount** `object`
>
> New amount for the expense entry (Workday Currency object — typically `{"value": <amount>, "currency": {"id": <WID>}}`).
>
> **merchant** `string`
>
> New merchant name for the expense entry.
>
> **attachments** `array`
>
> Optional list of attachments (e.g. receipt images) to associate with the entry.
>
> **expenseItem** `object`
>
> Expense item (category) reference for the Quick Expense.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Give Requested Feedback Event
>
> **Slug:** `WORKDAY_PATCH_GIVE_REQUESTED_FEEDBACK_EVENT`
>
> Updates 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Message Template By ID
>
> **Slug:** `WORKDAY_PATCH_MESSAGE_TEMPLATE_BY_ID`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the message template to update.
>
> **name** `string`
>
> New name for the message template.
>
> **inactive** `boolean`
>
> Indicates whether the template is active or has been disabled.
>
> **descriptor** `string`
>
> A preview of the instance.
>
> **pushDetail** `object`
>
> Container for push notification data, used in REST API.
>
> **emailDetail** `object`
>
> Email Configuration container for REST API.
>
> **referenceID** `string`
>
> The Reference ID to use for lookups within Workday Web Services.
>
> **notificationType** `object`
>
> Notification Type indicates where the template can be used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Organization Goal
>
> **Slug:** `WORKDAY_PATCH_ORGANIZATION_GOAL`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Payroll Interface Pay Group Period
>
> **Slug:** `WORKDAY_PATCH_PAYROLL_INTERFACE_PAY_GROUP_PERIOD`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the pay group.
>
> **status** `string`
>
> New status for the pay period (e.g., 'Closed', 'Open').
>
> **periodEndDate** `string`
>
> New end date for the pay period (yyyy-mm-dd).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the pay period to update.
>
> **periodStartDate** `string`
>
> New start date for the pay period (yyyy-mm-dd).
>
> **periodIsEarliestOpen** `boolean`
>
> Whether this period is the earliest open pay period.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Worker Development Item
>
> **Slug:** `WORKDAY_PATCH_WORKER_DEVELOPMENT_ITEM`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource. - **ID:** Replace with your actual Workday ID - **me**
>
> **body** `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).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Post WQL Query
>
> **Slug:** `WORKDAY_POST_WQL_QUERY`
>
> Runs 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
>
> **query** `string`
>
> The WQL query to execute. POST accepts queries longer than 2,048 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Certification
>
> **Slug:** `WORKDAY_PUT_CERTIFICATION`
>
> Executes put certification in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **certification\_id** `string`
>
> Optional Certification reference identifier for updates/deletes.
>
> **certification\_data** `object` *required*
>
> Workday Certification\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **certification\_id\_type** `string`
>
> Identifier type for certification\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Certification Issuer
>
> **Slug:** `WORKDAY_PUT_CERTIFICATION_ISSUER`
>
> Executes put certification issuer in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **certification\_issuer\_id** `string`
>
> Optional Certification Issuer reference identifier for updates/deletes.
>
> **certification\_issuer\_data** `object`
>
> Workday Certification\_Issuer\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **certification\_issuer\_id\_type** `string`
>
> Identifier type for certification\_issuer\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Check In
>
> **Slug:** `WORKDAY_PUT_CHECK_IN`
>
> Executes put check in in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **check\_in\_id** `string`
>
> Optional Check In reference identifier for updates/deletes.
>
> **check\_in\_data** `object`
>
> Workday Check-In\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **check\_in\_id\_type** `string`
>
> Identifier type for check\_in\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Check In Topic
>
> **Slug:** `WORKDAY_PUT_CHECK_IN_TOPIC`
>
> Executes put check in topic in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **check\_in\_topic\_id** `string`
>
> Optional Check In Topic reference identifier for updates/deletes.
>
> **check\_in\_topic\_data** `object` *required*
>
> Workday Check-In\_Topic\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **check\_in\_topic\_id\_type** `string`
>
> Identifier type for check\_in\_topic\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Competency
>
> **Slug:** `WORKDAY_PUT_COMPETENCY`
>
> Executes put competency in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **competency\_id** `string`
>
> Optional Competency reference identifier for updates/deletes.
>
> **competency\_data** `object`
>
> Workday Competency\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **competency\_id\_type** `string`
>
> Identifier type for competency\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Competency Category
>
> **Slug:** `WORKDAY_PUT_COMPETENCY_CATEGORY`
>
> Executes put competency category in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **competency\_category\_id** `string`
>
> Optional Competency Category reference identifier for updates/deletes.
>
> **competency\_category\_data** `object`
>
> Workday Competency\_Category\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **competency\_category\_id\_type** `string`
>
> Identifier type for competency\_category\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Degree
>
> **Slug:** `WORKDAY_PUT_DEGREE`
>
> Executes put degree in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **degree\_id** `string`
>
> Optional Degree reference identifier for updates/deletes.
>
> **degree\_data** `object` *required*
>
> Workday Degree\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **degree\_id\_type** `string`
>
> Identifier type for degree\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Feedback Badge
>
> **Slug:** `WORKDAY_PUT_FEEDBACK_BADGE`
>
> Executes a put feedback badge operation in Workday Performance Management, with an option to request deletion of the referenced badge.
>
> #### Input Parameters
>
> **delete** `boolean`
>
> Whether Workday should delete the referenced object when supported by this operation.
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **feedback\_badge\_id** `string`
>
> Optional Feedback Badge reference identifier for updates/deletes.
>
> **feedback\_badge\_data** `object` *required*
>
> Workday Feedback\_Badge\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **feedback\_badge\_id\_type** `string`
>
> Identifier type for feedback\_badge\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Feedback Question
>
> **Slug:** `WORKDAY_PUT_FEEDBACK_QUESTION`
>
> Executes a put feedback question operation in Workday Performance Management, with an option to request deletion of the referenced question.
>
> #### Input Parameters
>
> **delete** `boolean`
>
> Whether Workday should delete the referenced object when supported by this operation.
>
> **feedback\_question\_id** `string`
>
> Optional Feedback Question reference identifier for updates/deletes.
>
> **feedback\_question\_data** `object` *required*
>
> Workday Feedback\_Question\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **feedback\_question\_id\_type** `string`
>
> Identifier type for feedback\_question\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Field Of Study
>
> **Slug:** `WORKDAY_PUT_FIELD_OF_STUDY`
>
> Executes put field of study in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **field\_of\_study\_id** `string`
>
> Optional Field Of Study reference identifier for updates/deletes.
>
> **field\_of\_study\_data** `object`
>
> Workday Field\_Of\_Study\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **field\_of\_study\_id\_type** `string`
>
> Identifier type for field\_of\_study\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Goal Payout Band
>
> **Slug:** `WORKDAY_PUT_GOAL_PAYOUT_BAND`
>
> Executes put goal payout band in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **goal\_payout\_band\_id** `string`
>
> Optional Goal Payout Band reference identifier for updates/deletes.
>
> **goal\_payout\_band\_data** `object` *required*
>
> Workday Goal\_Payout\_Band\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **goal\_payout\_band\_id\_type** `string`
>
> Identifier type for goal\_payout\_band\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Goal Unit
>
> **Slug:** `WORKDAY_PUT_GOAL_UNIT`
>
> Executes a put goal unit operation in Workday Performance Management, with an option to request deletion of the referenced goal unit.
>
> #### Input Parameters
>
> **delete** `boolean`
>
> Whether Workday should delete the referenced object when supported by this operation.
>
> **goal\_unit\_id** `string`
>
> Optional Goal Unit reference identifier for updates/deletes.
>
> **goal\_unit\_data** `object` *required*
>
> Workday Goal\_Unit\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **goal\_unit\_id\_type** `string`
>
> Identifier type for goal\_unit\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Organization Goal
>
> **Slug:** `WORKDAY_PUT_ORGANIZATION_GOAL`
>
> Executes put organization goal in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **organization\_goal\_id** `string`
>
> Optional Organization Goal reference identifier for updates/deletes.
>
> **organization\_goal\_data** `object` *required*
>
> Workday Organization\_Goal\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **organization\_goal\_id\_type** `string`
>
> Identifier type for organization\_goal\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Review Question
>
> **Slug:** `WORKDAY_PUT_REVIEW_QUESTION`
>
> Executes a put review question operation in Workday Performance Management, with an option to request deletion of the referenced question.
>
> #### Input Parameters
>
> **delete** `boolean`
>
> Whether Workday should delete the referenced object when supported by this operation.
>
> **review\_question\_id** `string`
>
> Optional Review Question reference identifier for updates/deletes.
>
> **review\_question\_data** `object` *required*
>
> Workday Review\_Question\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **review\_question\_id\_type** `string`
>
> Identifier type for review\_question\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Review Question Category
>
> **Slug:** `WORKDAY_PUT_REVIEW_QUESTION_CATEGORY`
>
> Puts a review question category in Workday Performance Management, with an optional reference and delete flag.
>
> #### Input Parameters
>
> **delete** `boolean`
>
> Whether Workday should delete the referenced object when supported by this operation.
>
> **review\_question\_category\_id** `string`
>
> Optional Review Question Category reference identifier for updates/deletes.
>
> **review\_question\_category\_data** `object` *required*
>
> Workday Review\_Question\_Category\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **review\_question\_category\_id\_type** `string`
>
> Identifier type for review\_question\_category\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put Review Type
>
> **Slug:** `WORKDAY_PUT_REVIEW_TYPE`
>
> Puts a review type in Workday Performance Management, with an optional reference, add-only setting, and delete flag.
>
> #### Input Parameters
>
> **delete** `boolean`
>
> Whether Workday should delete the referenced object when supported by this operation.
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **review\_type\_id** `string`
>
> Optional Review Type reference identifier for updates/deletes.
>
> **review\_type\_data** `object` *required*
>
> Workday Review\_Type\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **review\_type\_id\_type** `string`
>
> Identifier type for review\_type\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Put School Type
>
> **Slug:** `WORKDAY_PUT_SCHOOL_TYPE`
>
> Executes put school type in Workday Performance Management.
>
> #### Input Parameters
>
> **add\_only** `boolean`
>
> When true, Workday treats the request as add-only and fails if the referenced object already exists.
>
> **school\_type\_id** `string`
>
> Optional School Type reference identifier for updates/deletes.
>
> **school\_type\_data** `object` *required*
>
> Workday School\_Type\_Data object. Use Workday SOAP element names as keys and nested dictionaries/lists for child elements.
>
> **school\_type\_id\_type** `string`
>
> Identifier type for school\_type\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reassign Business Process Event Step
>
> **Slug:** `WORKDAY_REASSIGN_BUSINESS_PROCESS_EVENT_STEP`
>
> Reassigns 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event step to reassign.
>
> **comment** `string`
>
> Optional comment recorded on the event step explaining the reassignment.
>
> **addAssignees** `array`
>
> List of person reference objects (\{id} or \{id, descriptor}) to add as assignees on this step.
>
> **awaitingRoles** `array`
>
> Optional list of role reference objects (\{id} or \{id, descriptor}) the event step is awaiting after the reassignment.
>
> **removeAssignees** `array`
>
> List of person reference objects (\{id} or \{id, descriptor}) to remove from the step's assignee list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Refer Candidate
>
> **Slug:** `WORKDAY_REFER_CANDIDATE`
>
> Initiate 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
>
> **name** `object` *required*
>
> Candidate's required legal name.
>
> **comment** `string`
>
> Comment about the candidate referral.
>
> **contact** `object` *required*
>
> Candidate's required country and email or complete phone details.
>
> **job\_areas** `array`
>
> One or more enabled Recruiting job areas for this referral.
>
> **job\_requisitions** `array`
>
> One or more job requisitions for this referral.
>
> **referral\_relationship** `object`
>
> Configured referral relationship when referral levels are enabled.
>
> **referred\_by\_worker\_id** `string` *required*
>
> Workday identifier for the referring worker.
>
> **referral\_consent\_given** `boolean`
>
> Whether the candidate gave referral consent when required by country.
>
> **referred\_by\_worker\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Official Workday WorkerObject identifier type for the referring worker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Home Contact Information Email Address
>
> **Slug:** `WORKDAY_REMOVE_HOME_CONTACT_INFORMATION_EMAIL_ADDRESS`
>
> Removes 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
>
> **ID** `string` *required*
>
> The Workday ID of the home contact information change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the email address subresource to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace Home Contact Change Address
>
> **Slug:** `WORKDAY_REPLACE_HOME_CONTACT_CHANGE_ADDRESS`
>
> Updates 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
>
> **id** `string`
>
> Deprecated top-level alias; use changes.id.
>
> **city** `string`
>
> Deprecated top-level alias; use changes.city.
>
> **usage** `object`
>
> Deprecated top-level alias; use changes.usage.
>
> **changes** `object`
>
> Writable fields to change. The tool first reads the staged address and merges these fields into that complete provider representation before PUT.
>
> **country** `object`
>
> Deprecated top-level alias; use changes.country.
>
> **event\_id** `string` *required*
>
> Home Contact Change event ID returned by the initiate tool.
>
> **cityLocal** `string`
>
> Deprecated top-level alias; use changes.cityLocal.
>
> **address\_id** `string` *required*
>
> Staged address ID returned by the address-list tool.
>
> **postalCode** `string`
>
> Deprecated top-level alias; use changes.postalCode.
>
> **countryCity** `object`
>
> Deprecated top-level alias; use changes.countryCity.
>
> **addressLine1** `string`
>
> Deprecated top-level alias; use changes.addressLine1.
>
> **addressLine2** `string`
>
> Deprecated top-level alias; use changes.addressLine2.
>
> **addressLine3** `string`
>
> Deprecated top-level alias; use changes.addressLine3.
>
> **addressLine4** `string`
>
> Deprecated top-level alias; use changes.addressLine4.
>
> **addressLine5** `string`
>
> Deprecated top-level alias; use changes.addressLine5.
>
> **addressLine6** `string`
>
> Deprecated top-level alias; use changes.addressLine6.
>
> **addressLine7** `string`
>
> Deprecated top-level alias; use changes.addressLine7.
>
> **addressLine8** `string`
>
> Deprecated top-level alias; use changes.addressLine8.
>
> **addressLine9** `string`
>
> Deprecated top-level alias; use changes.addressLine9.
>
> **countryRegion** `object`
>
> Deprecated top-level alias; use changes.countryRegion.
>
> **numberDaysWFH** `integer`
>
> Deprecated top-level alias; use changes.numberDaysWFH.
>
> **citySubdivision1** `string`
>
> Deprecated top-level alias; use changes.citySubdivision1.
>
> **citySubdivision2** `string`
>
> Deprecated top-level alias; use changes.citySubdivision2.
>
> **addressLine1Local** `string`
>
> Deprecated top-level alias; use changes.addressLine1Local.
>
> **addressLine2Local** `string`
>
> Deprecated top-level alias; use changes.addressLine2Local.
>
> **addressLine3Local** `string`
>
> Deprecated top-level alias; use changes.addressLine3Local.
>
> **addressLine4Local** `string`
>
> Deprecated top-level alias; use changes.addressLine4Local.
>
> **addressLine5Local** `string`
>
> Deprecated top-level alias; use changes.addressLine5Local.
>
> **addressLine6Local** `string`
>
> Deprecated top-level alias; use changes.addressLine6Local.
>
> **addressLine7Local** `string`
>
> Deprecated top-level alias; use changes.addressLine7Local.
>
> **addressLine8Local** `string`
>
> Deprecated top-level alias; use changes.addressLine8Local.
>
> **addressLine9Local** `string`
>
> Deprecated top-level alias; use changes.addressLine9Local.
>
> **regionSubdivision1** `string`
>
> Deprecated top-level alias; use changes.regionSubdivision1.
>
> **regionSubdivision2** `string`
>
> Deprecated top-level alias; use changes.regionSubdivision2.
>
> **citySubdivision1Local** `string`
>
> Deprecated top-level alias; use changes.citySubdivision1Local.
>
> **citySubdivision2Local** `string`
>
> Deprecated top-level alias; use changes.citySubdivision2Local.
>
> **regionSubdivision1Local** `string`
>
> Deprecated top-level alias; use changes.regionSubdivision1Local.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request One-Time Payment
>
> **Slug:** `WORKDAY_REQUEST_ONE_TIME_PAYMENT`
>
> Initiate, 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
>
> **reason** `object` *required*
>
> One-time-payment reason. LIST\_ONE\_TIME\_PAYMENT\_REASON\_CANDIDATES returns candidates only; verify eligibility before initiating the event.
>
> **position** `object` *required*
>
> Worker position returned by DISCOVER\_ONE\_TIME\_PAYMENT\_OPTIONS.
>
> **worker\_id** `string` *required*
>
> Worker WID, typed Employee\_ID/Contingent\_Worker\_ID reference, or me.
>
> **effective\_date** `string` *required*
>
> Business-process effective date.
>
> **one\_time\_payments** `array` *required*
>
> One or more one-time-payment lines.
>
> **employee\_visibility\_date** `string`
>
> Date on which the compensation change becomes visible to the worker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rescind Business Process Event
>
> **Slug:** `WORKDAY_RESCIND_BUSINESS_PROCESS_EVENT`
>
> Rescinds 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event to rescind.
>
> **comment** `string`
>
> Optional reason recorded on the event for the rescission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Absence Plan Balances
>
> **Slug:** `WORKDAY_RETRIEVE_ABSENCE_PLAN_BALANCES`
>
> Retrieves 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
>
> **limit** `integer`
>
> The maximum number of objects in a single response. Default 20, maximum 100.
>
> **offset** `integer`
>
> The zero-based index of the first object in a response collection. Default 0. Use with limit for pagination.
>
> **worker** `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.
>
> **category** `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).
>
> **effective** `string`
>
> The absence balances as of the specified date in yyyy-mm-dd format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run WQL Query
>
> **Slug:** `WORKDAY_RUN_WQL_QUERY`
>
> Runs 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
>
> **limit** `integer`
>
> Maximum number of result rows in a single response. Default 20, max 100.
>
> **query** `string`
>
> The WQL query to execute. Example: 'SELECT worker FROM allWorkers'.
>
> **offset** `integer`
>
> Zero-based index of the first row in the response. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Back Business Process Event Step
>
> **Slug:** `WORKDAY_SEND_BACK_BUSINESS_PROCESS_EVENT_STEP`
>
> Sends 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
>
> **ID** `string` *required*
>
> The Workday ID of the business process event step to send back.
>
> **to** `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.
>
> **reason** `string` *required*
>
> Reason recorded on the event step for sending it back. Workday surfaces this as the user comment on the audit trail.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message
>
> **Slug:** `WORKDAY_SEND_MESSAGE`
>
> Sends 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
>
> **commID** `string`
>
> Communication ID for threading / correlating this message with other Workday communications.
>
> **pushDetail** `object`
>
> Push-notification-channel content for the message.
>
> **recipients** `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).
>
> **emailDetail** `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.
>
> **senderOverride** `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.
>
> **messageTemplate** `object`
>
> Message-template instance reference (`{'id': '<message-template-id>'}`) to use as the basis for the email and/or push content.
>
> **notificationType** `object`
>
> Notification-type instance reference (`{'id': '<notification-type-id>'}`) used to pick the template/channel routing for the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Supplier Invoice Attachments For Scanning
>
> **Slug:** `WORKDAY_SEND_SUPPLIER_INVOICE_ATTACHMENTS_FOR_SCANNING`
>
> Submits 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
>
> **ocrSupplierInvoices** `array`
>
> Collection of supplier invoice attachments to send to the OCR scanning queue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Performance Review
>
> **Slug:** `WORKDAY_START_PERFORMANCE_REVIEW`
>
> Creates an in-progress or completed Workday performance review for an employee.
>
> #### Input Parameters
>
> **comment** `string`
>
> Optional business process comment.
>
> **run\_now** `boolean`
>
> Whether Workday should run the business process immediately.
>
> **manager\_id** `string`
>
> Optional manager identifier for the manager evaluation subprocess.
>
> **employee\_id** `string` *required*
>
> Employee identifier for the worker receiving the performance review.
>
> **auto\_complete** `boolean`
>
> Whether Workday should automatically complete the main business process when possible.
>
> **manager\_comment** `string`
>
> Optional manager evaluation overall comment.
>
> **manager\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Identifier type for manager\_id.
>
> **period\_end\_date** `string`
>
> Optional review period end date in YYYY-MM-DD format.
>
> **employee\_id\_type** `string ("WID" | "Employee_ID")`
>
> Identifier type for employee\_id.
>
> **comment\_worker\_id** `string`
>
> Optional worker identifier to associate with the business process comment.
>
> **period\_start\_date** `string`
>
> Optional review period start date in YYYY-MM-DD format.
>
> **review\_template\_id** `string` *required*
>
> Employee review template identifier used to start the performance review.
>
> **comment\_worker\_id\_type** `string ("WID" | "Employee_ID" | "Contingent_Worker_ID")`
>
> Identifier type for comment\_worker\_id.
>
> **review\_template\_id\_type** `string ("WID" | "Employee_Review_Template_ID")`
>
> Identifier type for review\_template\_id.
>
> **manager\_overall\_rating\_id** `string`
>
> Optional manager overall rating identifier.
>
> **manager\_overall\_rating\_id\_type** `string ("WID" | "Review_Rating_ID")`
>
> Identifier type for manager\_overall\_rating\_id.
>
> **manager\_overall\_rating\_override** `number`
>
> Optional numeric manager overall rating override.
>
> **discard\_on\_exit\_validation\_error** `boolean`
>
> Whether Workday should discard the transaction on exit validation errors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Business Process Event Step Questionnaire
>
> **Slug:** `WORKDAY_SUBMIT_BUSINESS_PROCESS_EVENT_STEP_QUESTIONNAIRE`
>
> Submits 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
>
> **ID** `string` *required*
>
> The Workday ID of the questionnaire-type business process event step to submit.
>
> **stepAction** `object`
>
> Optional step-action reference object (\{id} or \{id, descriptor}) selecting which submit variant to perform.
>
> **questionnaireResponse** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Business Process Event Step ToDo
>
> **Slug:** `WORKDAY_SUBMIT_BUSINESS_PROCESS_EVENT_STEP_TO_DO`
>
> Submits 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
>
> **ID** `string` *required*
>
> The Workday ID of the ToDo-type business process event step to submit.
>
> **comment** `string`
>
> Optional comment recorded with the ToDo submission.
>
> **stepAction** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Home Contact Change
>
> **Slug:** `WORKDAY_SUBMIT_HOME_CONTACT_CHANGE`
>
> Submit 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
>
> **event\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Job Change
>
> **Slug:** `WORKDAY_SUBMIT_JOB_CHANGE`
>
> Submits 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
>
> **ID** `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.
>
> **validation** `string`
>
> Validation mode. Set to 'true' to validate without submitting, or 'false' (or omit) to perform the actual submission.
>
> **businessProcessParameters** `object`
>
> Model for business process parameters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Organization Assignment Change
>
> **Slug:** `WORKDAY_SUBMIT_ORGANIZATION_ASSIGNMENT_CHANGE`
>
> Submits 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource to submit.
>
> **businessProcessParameters** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Work Contact Change
>
> **Slug:** `WORKDAY_SUBMIT_WORK_CONTACT_CHANGE`
>
> Submit 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Contact Change Event
>
> **descriptor** `string`
>
> The display name of the instance
>
> **businessProcessParameters** `object`
>
> The businessProcessParameters field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update An Existing Payroll
>
> **Slug:** `WORKDAY_UPDATE_AN_EXISTING_PAYROLL`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the payroll input instance to update.
>
> **comment** `string`
>
> Comment for the payroll input update.
>
> **endDate** `string`
>
> The end date for the payroll input, using the date format yyyy-mm-dd.
>
> **ongoing** `boolean`
>
> Whether the payroll input is ongoing (recurring) or one-time.
>
> **currency** `object`
>
> Reference to a currency in Workday
>
> **position** `object`
>
> Reference to a position in Workday
>
> **worktags** `array`
>
> List of worktags for the payroll input.
>
> **startDate** `string`
>
> The start date for the payroll input, using the date format yyyy-mm-dd.
>
> **adjustment** `boolean`
>
> Whether this is an adjustment to an existing payroll input.
>
> **inputDetails** `array`
>
> List of input details for the payroll input.
>
> **payComponent** `object`
>
> Reference to a pay component in Workday
>
> **runCategories** `array`
>
> List of run categories for the payroll input.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Compensation Scorecard
>
> **Slug:** `WORKDAY_UPDATE_COMPENSATION_SCORECARD`
>
> Replaces 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
>
> **ID** `string` *required*
>
> The Workday ID of the Compensation Scorecard to update.
>
> **id** `string`
>
> Optional Workday ID or Reference ID echoed in the body; usually omitted because the path ID already identifies the scorecard.
>
> **inactive** `boolean`
>
> Replaces the inactive flag as of the specified effectiveDate. Defaults to false in Workday.
>
> **effectiveDate** `string` *required*
>
> The Effective Date of the updates to the Compensation Scorecard (YYYY-MM-DD).
>
> **scorecardName** `string` *required*
>
> Replaces the name of the Compensation Scorecard as of the specified effectiveDate.
>
> **scorecardProfiles** `array`
>
> Replaces the profile sections; if previously set and omitted here, the profiles are deleted as of effectiveDate.
>
> **scorecardDescription** `string`
>
> Replaces the description; if previously set and omitted here, the description is deleted as of effectiveDate.
>
> **defaultScorecardGoals** `array` *required*
>
> Replaces the array of Default Scorecard Goals as of the specified effectiveDate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Field Type
>
> **Slug:** `WORKDAY_UPDATE_CUSTOM_FIELD_TYPE`
>
> Replaces 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom field type to replace.
>
> **body** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Field Type List Value
>
> **Slug:** `WORKDAY_UPDATE_CUSTOM_FIELD_TYPE_LIST_VALUE`
>
> Replaces 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom field type (custom list) that owns the list value.
>
> **body** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the list value to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Object
>
> **Slug:** `WORKDAY_UPDATE_CUSTOM_OBJECT`
>
> Updates 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
>
> **customObjectID** `string` *required*
>
> Either the extended Workday object ID or the custom object's own ID.
>
> **customObjectAlias** `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.
>
> **customObjectFields** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Object Definition Condition Rule
>
> **Slug:** `WORKDAY_UPDATE_CUSTOM_OBJECT_DEFINITION_CONDITION_RULE`
>
> Replaces 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the condition rule.
>
> **body** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the condition rule to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Object Definition Field
>
> **Slug:** `WORKDAY_UPDATE_CUSTOM_OBJECT_DEFINITION_FIELD`
>
> Replaces 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the field.
>
> **body** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the field to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Object Definition Validation
>
> **Slug:** `WORKDAY_UPDATE_CUSTOM_OBJECT_DEFINITION_VALIDATION`
>
> Replaces 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
>
> **ID** `string` *required*
>
> The Workday ID of the custom object definition that owns the validation.
>
> **body** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the validation to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Employee Review Rating
>
> **Slug:** `WORKDAY_UPDATE_EMPLOYEE_REVIEW_RATING`
>
> Updates manager rating inputs for a Workday employee review.
>
> #### Input Parameters
>
> **id** `string`
>
> Optional employee review data ID. Use when not providing employee\_review\_id.
>
> **comment** `string`
>
> Optional overall manager comment for the review.
>
> **rating\_id** `string`
>
> Optional overall review rating identifier.
>
> **rating\_id\_type** `string ("WID" | "Review_Rating_ID")`
>
> Identifier type for rating\_id.
>
> **manual\_override** `number`
>
> Optional manual numeric overall rating override.
>
> **review\_sections** `array`
>
> Optional manager rating and comment data by review section.
>
> **employee\_review\_id** `string`
>
> Optional employee review identifier. Workday uses this reference before the data ID when both are provided.
>
> **employee\_review\_id\_type** `string ("WID" | "Employee_Review_ID")`
>
> Identifier type for employee\_review\_id.
>
> **override\_overall\_rating** `boolean`
>
> Whether to override the calculated overall review rating.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Expense Entry
>
> **Slug:** `WORKDAY_UPDATE_EXPENSE_ENTRY`
>
> Updates (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
>
> **ID** `string` *required*
>
> The Workday ID of the Quick Expense entry to update.
>
> **date** `string` *required*
>
> Transaction date for the expense entry (YYYY-MM-DD).
>
> **memo** `string`
>
> Free-form memo to attach to the expense entry.
>
> **image** `object`
>
> A Workday instance reference (id / descriptor / href).
>
> **amount** `object`
>
> Amount for the expense entry (Workday Currency object — typically `{"value": <amount>, "currency": {"id": <WID>}}`).
>
> **merchant** `string`
>
> Name of the merchant for the expense entry.
>
> **attachments** `array`
>
> Optional replacement list of attachments (e.g. receipt images) for the entry.
>
> **expenseItem** `object`
>
> Expense item (category) reference for the Quick Expense.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Home Contact Change Email Address
>
> **Slug:** `WORKDAY_UPDATE_HOME_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Email Reference
>
> **usage** `object`
>
> The usage field.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **emailAddress** `string`
>
> The email address.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Home Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_UPDATE_HOME_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Instant Messenger Reference
>
> **type** `object`
>
> The type field.
>
> **usage** `object`
>
> The usage field.
>
> **userName** `string`
>
> The instant messenger account username.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Home Contact Change Phone Number
>
> **Slug:** `WORKDAY_UPDATE_HOME_CONTACT_CHANGE_PHONE_NUMBER`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Phone Reference
>
> **usage** `object`
>
> The usage field.
>
> **extension** `string`
>
> The phone extension.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **deviceType** `object`
>
> The deviceType field.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> **countryPhoneCode** `object`
>
> The countryPhoneCode field.
>
> **completePhoneNumber** `string`
>
> The complete phone number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Home Contact Change Web Address
>
> **Slug:** `WORKDAY_UPDATE_HOME_CONTACT_CHANGE_WEB_ADDRESS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Web Address Reference
>
> **url** `string`
>
> The complete URL address for the web address.
>
> **usage** `object`
>
> The usage field.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Change Business Title
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGE_BUSINESS_TITLE`
>
> Partially 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
>
> **ID** `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.
>
> **businessTitle** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the business title subresource. For singleton subresources like businessTitle, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Change Comment
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGE_COMMENT`
>
> Partially 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
>
> **ID** `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.
>
> **comment** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the comment subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Administrative
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_ADMINISTRATIVE`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **fte** `number`
>
> Full Time Equivalent for a worker (scheduled weekly hours / default weekly hours).
>
> **paidFte** `number`
>
> The paid full time equivalent for the worker as of the effective date.
>
> **notifyBy** `string`
>
> The date that the employee should be notified for a termination (ISO 8601 date).
>
> **timeType** `object`
>
> The time type for the worker as of the effective date.
>
> **workStudy** `object`
>
> The work-study program for the worker as of the effective date.
>
> **workingFte** `number`
>
> The working full time equivalent for the worker as of the effective date.
>
> **payRateType** `object`
>
> The pay rate type for the worker as of the effective date. Provide an instance reference (e.g. \{'id': '\<wid>'}).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the administrative subresource. For singleton subresources like administrative, this typically matches the job change ID.
>
> **assignmentType** `object`
>
> The assignment type for the worker as of the effective date.
>
> **firstDayOfWork** `string`
>
> The first day of work for the worker (ISO 8601 date).
>
> **specifyPaidFte** `boolean`
>
> True if paid full time equivalent is specified on a worker as of the effective date.
>
> **endEmploymentDate** `string`
>
> The new End Employment Date for the worker (ISO 8601 date).
>
> **specifyWorkingFte** `boolean`
>
> True if working full time equivalent is specified on a worker as of the effective date.
>
> **defaultWeeklyHours** `number`
>
> The new default weekly hours for the worker as of the effective date.
>
> **positionWorkerType** `object`
>
> The position worker type for the worker as of the effective date.
>
> **companyInsiderTypes** `array`
>
> The new company insider types for the worker as of the effective date.
>
> **expectedAssignmentEndDate** `string`
>
> The Expected Assignment End Date proposed in the business process (ISO 8601 date).
>
> **workersCompensationCodeOverride** `object`
>
> The workers' compensation code override for the worker as of the effective date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Contract
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_CONTRACT`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **currency** `object`
>
> The currency for the contract pay rate. Provide an instance reference (e.g. \{'id': '\<wid>'}).
>
> **frequency** `object`
>
> The frequency for the contract pay rate.
>
> **purchaseOrder** `object`
>
> The purchase order associated with the contract.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the contract subresource. For singleton subresources like contract, this typically matches the job change ID.
>
> **contractEndDate** `string`
>
> The contract end date for the position as of this business process (ISO 8601 date).
>
> **contractPayRate** `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}).
>
> **assignmentDetails** `string`
>
> The new contract assignment details for the contingent worker as of the effective date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Job Profile
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_JOB_PROFILE`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **jobTitle** `string`
>
> The new job title for the worker as of the effective date.
>
> **jobProfile** `object`
>
> The proposed job profile for the worker. Provide an instance reference (e.g. \{'id': '\<job-profile-wid>'}).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the jobProfile subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Location
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_LOCATION`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **location** `object`
>
> The location for the worker as of the effective date.
>
> **workShift** `object`
>
> The work shift for the worker as of the effective date.
>
> **workSpace** `object`
>
> The workspace for the worker as of the effective date. Provide an instance reference (e.g. \{'id': '\<wid>'}).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the location subresource. For singleton subresources, this typically matches the job change ID.
>
> **scheduledHours** `number`
>
> The new scheduled hours for the worker as of the effective date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Move Team
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_MOVE_TEAM`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **moveTeam** `boolean`
>
> Set to true to move teams reporting to the Manager with them as part of the Change Job event; false otherwise.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the moveTeam subresource. For singleton subresources, this typically matches the job change ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Opening
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_OPENING`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **descriptor** `string`
>
> The display name of the opening instance.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the opening subresource. For singleton subresources, this typically matches the job change ID.
>
> **headcountOption** `object`
>
> The headcount option for the opening. Provide an instance reference (e.g. \{'id': '\<wid>'}).
>
> **openingAvailableForOverlap** `boolean`
>
> Set to true if the 'Available for job overlap' option should be enabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Change Position Options
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_POSITION_OPTIONS`
>
> Partially 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
>
> **ID** `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.
>
> **position** `object`
>
> Detailed position information. May contain id, descriptor, href, and other position-specific attributes.
>
> **descriptor** `string`
>
> Human-readable name or description for the position.
>
> **positionId** `string`
>
> The Workday ID of the position to associate with this job change. Sent as 'id' in the request body.
>
> **closePosition** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the position subresource within the job change.
>
> **createPosition** `boolean`
>
> Indicates whether a new position should be created as part of this job change. Either this or a proposed position must be selected.
>
> **jobRequisition** `object`
>
> Job requisition information to associate with this position. May contain id, descriptor, and href fields.
>
> **availableForOverlap** `boolean`
>
> Indicates whether the position is available for overlap with other positions. Set either this or closePosition to true, but not both.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Changes Start Details
>
> **Slug:** `WORKDAY_UPDATE_JOB_CHANGES_START_DETAILS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the job change resource.
>
> **job** `object`
>
> The job associated with the job change.
>
> **date** `string` *required*
>
> The date this business process takes effect (ISO 8601 date). This field is required by the spec.
>
> **reason** `object`
>
> The reason for the job change. Provide an instance reference (e.g. \{'id': '\<wid>'}).
>
> **worker** `object`
>
> The worker involved in the job change.
>
> **location** `object`
>
> The location associated with the job change.
>
> **template** `object`
>
> The template used for the job change.
>
> **descriptor** `string`
>
> The display name of the instance.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the startDetails subresource. For singleton subresources, this typically matches the job change ID.
>
> **useNextPayPeriod** `boolean`
>
> Whether to use the next pay period for the change.
>
> **supervisoryOrganization** `object`
>
> The supervisory organization for the job change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Classification Options
>
> **Slug:** `WORKDAY_UPDATE_JOB_CLASSIFICATION_OPTIONS`
>
> Partially updates additional job classifications for an in-progress Workday Staffing job change. The change must be submitted to persist.
>
> #### Input Parameters
>
> **ID** `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.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the job classification subresource. For singleton subresources like jobClassification, this typically matches the job change ID.
>
> **additionalJobClassifications** `array`
>
> List of additional job classification references to associate with the job change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Message Template By ID
>
> **Slug:** `WORKDAY_UPDATE_MESSAGE_TEMPLATE_BY_ID`
>
> Updates an existing message template instance. Replaces the existing instance with the specified data in the request body.
>
> #### Input Parameters
>
> **ID** `string` *required*
>
> The Workday ID of the message template to update.
>
> **name** `string` *required*
>
> Message Template name (required).
>
> **inactive** `boolean`
>
> Indicates whether the template is active or has been disabled.
>
> **descriptor** `string`
>
> A preview of the instance.
>
> **pushDetail** `object`
>
> Container for push notification data, used in REST API.
>
> **emailDetail** `object`
>
> Email Configuration container for REST API.
>
> **referenceID** `string`
>
> The Reference ID to use for lookups within Workday Web Services.
>
> **notificationType** `object` *required*
>
> Notification Type indicates where the template can be used (required).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Business Unit
>
> **Slug:** `WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_BUSINESS_UNIT`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **businessUnit** `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/.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the businessUnit subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Comment
>
> **Slug:** `WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_COMMENT`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **comment** `string`
>
> The business process comment for the worker event before it's submitted.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the comment subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Company
>
> **Slug:** `WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_COMPANY`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **company** `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/.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the company subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Cost Center
>
> **Slug:** `WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_COST_CENTER`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **costCenter** `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/.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the costCenter subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Region
>
> **Slug:** `WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_REGION`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **region** `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/.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the region subresource. Must match the ID value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Start Details
>
> **Slug:** `WORKDAY_UPDATE_ORGANIZATION_ASSIGNMENT_CHANGES_START_DETAILS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **date** `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.
>
> **worker** `object`
>
> Worker reference (read-only after event initiation; included for completeness).
>
> **position** `object`
>
> Position reference (read-only after event initiation; included for completeness).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the startDetails subresource. Must match the ID value.
>
> **supervisoryOrganization** `object`
>
> Supervisory organization reference (read-only after event initiation; included for completeness).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Organization Assignment Changes Custom Organizations
>
> **Slug:** `WORKDAY_UPDATE_ORG_ASSIGN_CHANGES_CUSTOM_ORGS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the organization assignment change resource.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the customOrganizations subresource. Must match the ID value.
>
> **customOrganizations** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Scorecard Result Score
>
> **Slug:** `WORKDAY_UPDATE_SCORECARD_RESULT_SCORE`
>
> Sets 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
>
> **ID** `string` *required*
>
> The Workday ID of the Scorecard Result whose score is being updated.
>
> **id** `string`
>
> Optional Workday ID or Reference ID echoed in the request body. Usually omitted because the path subresourceID already identifies the score.
>
> **descriptor** `string`
>
> Optional display-name override for the instance. Most callers can leave this unset.
>
> **achievement** `number`
>
> The achievement percentage for the scorecard criteria result. Specify a numeric value in the 1-100 range.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Score (the scorecard criteria result) within the Scorecard Result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Work Contact Change
>
> **Slug:** `WORKDAY_UPDATE_WORK_CONTACT_CHANGE`
>
> Update 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Work Contact Change Event
>
> **descriptor** `string`
>
> The display name of the instance
>
> **alternateWorkLocation** `object`
>
> The alternateWorkLocation field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Work Contact Change Email Address
>
> **Slug:** `WORKDAY_UPDATE_WORK_CONTACT_CHANGE_EMAIL_ADDRESS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Email Reference
>
> **usage** `object`
>
> The usage field.
>
> **descriptor** `string`
>
> The display name of the instance
>
> **emailAddress** `string`
>
> The email address.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Work Contact Change Instant Messenger
>
> **Slug:** `WORKDAY_UPDATE_WORK_CONTACT_CHANGE_INSTANT_MESSENGER`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Instant Messenger Reference
>
> **type** `object`
>
> The type field.
>
> **usage** `object`
>
> The usage field.
>
> **userName** `string`
>
> The instant messenger account username.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Work Contact Change Web Address
>
> **Slug:** `WORKDAY_UPDATE_WORK_CONTACT_CHANGE_WEB_ADDRESS`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the resource.
>
> **id** `string`
>
> The id for Web Address Reference
>
> **url** `string`
>
> The complete URL address for the web address.
>
> **usage** `object`
>
> The usage field.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the subresource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Work Contact Phone Number
>
> **Slug:** `WORKDAY_UPDATE_WORK_CONTACT_PHONE_NUMBER`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the Work Contact Information Change resource.
>
> **usage** `object`
>
> Usage information for the phone number.
>
> **extension** `string`
>
> Phone number extension. Not allowed when device type is VOIP.
>
> **descriptor** `string`
>
> Optional descriptor or display name for the phone number.
>
> **deviceType** `object`
>
> Reference to a phone device type.
>
> **subresourceID** `string` *required*
>
> The Workday ID of the phone number subresource to update.
>
> **countryPhoneCode** `object`
>
> Reference to a country phone code.
>
> **completePhoneNumber** `string`
>
> The complete phone number including country code and area code (e.g., '+1-555-123-4567'). Required unless device type is VOIP.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Worker Check-In
>
> **Slug:** `WORKDAY_UPDATE_WORKER_CHECK_IN`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker, or the literal string 'me' to refer to the current user.
>
> **date** `string`
>
> Updated date of the Check-In in YYYY-MM-DD format.
>
> **archive** `boolean`
>
> If True, archive the Check-In by sending ?type=archive. If False or None, perform a normal partial update with the supplied fields.
>
> **description** `string`
>
> Updated description of the Check-In (rich text).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Check-In to update.
>
> **associatedTopics** `array`
>
> Updated list of topics included in the Check-In.
>
> **checkInAttachments** `array`
>
> Updated attachments for the Check-In.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Worker Check-In Topic
>
> **Slug:** `WORKDAY_UPDATE_WORKER_CHECK_IN_TOPIC`
>
> Partially 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
>
> **ID** `string` *required*
>
> The Workday ID of the worker, or the literal string 'me' to refer to the current user.
>
> **name** `string`
>
> Updated topic name.
>
> **archive** `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.
>
> **sharedNotes** `string`
>
> Updated shared notes of the topic (rich text).
>
> **privateNotes** `string`
>
> Updated personal notes of the topic (rich text).
>
> **subresourceID** `string` *required*
>
> The Workday ID of the Check-In topic to update.
>
> **associatedCheckIns** `array`
>
> Updated list of Check-Ins associated to the topic.
>
> **checkInTopicAttachments** `array`
>
> Updated attachments for the Check-In topic.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Phone Number
>
> **Slug:** `WORKDAY_VALIDATE_PHONE_NUMBER`
>
> Validates 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
>
> **deviceType** `object`
>
> Reference to a phone device type.
>
> **countryPhoneCode** `object`
>
> Reference to a country phone code.
>
> **completePhoneNumber** `string` *required*
>
> The complete phone number to validate including country code and area code (e.g., '+1-555-123-4567'). Required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

## Triggers

> [accordion] Absence Balance Changed
>
> **Slug:** `WORKDAY_ABSENCE_BALANCE_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **absencePlan** `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.
>
> **effective** `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.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **worker** `string` *required*
>
> The Workday ID of the worker to monitor. This can be obtained from actions like 'Get Current User' or 'List Workers'.
>
> #### Payload
>
> **changed\_fields** `array`
>
> List of fields that changed (e.g., \['quantity', 'effectiveDate'])
>
> **current\_balance** `object` *required*
>
> The current balance details
>
> **previous\_balance** `object`
>
> Schema for absence balance details.
>
> **quantity\_change** `number`
>
> Change in quantity (positive for increase, negative for decrease)

> [accordion] Balance Details Changed
>
> **Slug:** `WORKDAY_BALANCE_DETAILS_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **absencePlan** `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.
>
> **effective** `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.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **worker** `string` *required*
>
> The Workday ID of the worker to monitor. This can be obtained from actions like 'Get Current User' or 'List Workers'.
>
> #### Payload
>
> **changed\_fields** `array`
>
> List of fields that changed (e.g., \['quantity', 'effectiveDate'])
>
> **current\_balance** `object` *required*
>
> The current balance details
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **previous\_balance** `object`
>
> Schema for balance details.

> [accordion] Interview Feedback Submitted or Updated
>
> **Slug:** `WORKDAY_INTERVIEW_FEEDBACK_SUBMITTED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **interview\_id** `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.
>
> **limit** `integer`
>
> The maximum number of feedback entries to check in each poll (1-100)
>
> #### Payload
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **feedback\_entry** `object` *required*
>
> The feedback entry that was submitted or updated
>
> **interview\_id** `string` *required*
>
> The Workday interview ID this feedback is associated with

> [accordion] Job Posting Changed
>
> **Slug:** `WORKDAY_JOB_POSTING_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **job\_posting\_id** `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
>
> **changed\_fields** `array`
>
> List of field names that changed between snapshots
>
> **current\_snapshot** `object` *required*
>
> Current state of the job posting
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **previous\_snapshot** `object`
>
> Schema representing a snapshot of a job posting's state.

> [accordion] Job Posting Questionnaire Changed
>
> **Slug:** `WORKDAY_JOB_POSTING_QUESTIONNAIRE_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **job\_posting\_id** `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.
>
> **questionnaire\_type** `array`
>
> Optional: Filter questionnaires by type (e.g., screening, pre-hire). If not specified, monitors all questionnaire types.
>
> #### Payload
>
> **changed\_fields** `array`
>
> List of top-level fields that changed (e.g., 'questionnaires', 'total\_questions')
>
> **current\_snapshot** `object` *required*
>
> The current questionnaire snapshot
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **previous\_snapshot** `object`
>
> Schema representing a snapshot of questionnaires.
>
> **questionnaires\_added** `integer`
>
> Number of questionnaires added since last poll
>
> **questionnaires\_removed** `integer`
>
> Number of questionnaires removed since last poll
>
> **questions\_added** `integer`
>
> Number of questions added since last poll
>
> **questions\_removed** `integer`
>
> Number of questions removed since last poll

> [accordion] New Absence Balance
>
> **Slug:** `WORKDAY_NEW_ABSENCE_BALANCE_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **category** `string`
>
> Optional: Filter by Workday ID of a specific Time Off Plan, Leave Type, or Absence Table category. Leave empty to monitor all categories.
>
> **effective** `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.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **limit** `integer`
>
> Maximum number of balance records to fetch in each poll (1-100). Default is 50.
>
> **worker** `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
>
> **absence\_balance** `object` *required*
>
> The newly detected absence balance record
>
> **event\_type** `string`
>
> Type of event that occurred

> [accordion] New Interview Scheduled
>
> **Slug:** `WORKDAY_NEW_INTERVIEW_SCHEDULED_TRIGGER`
>
> **Type:** poll
>
> Triggers when a new interview is scheduled/created in Workday. This trigger monitors interviews and fires when new interview records are detected.
>
> #### Configuration
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **interview\_status** `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.
>
> **limit** `integer`
>
> Maximum number of interviews to check in each poll (1-100)
>
> #### Payload
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **interview** `object` *required*
>
> The newly scheduled interview

> [accordion] New Job Posting
>
> **Slug:** `WORKDAY_NEW_JOB_POSTING_TRIGGER`
>
> **Type:** poll
>
> Triggers when a new job posting appears (newly published/opened) in Workday. This trigger monitors job postings and fires when new postings are detected.
>
> #### Configuration
>
> **category** `array`
>
> Filter job postings by category IDs. Leave empty to monitor all categories.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **job\_requisition** `array`
>
> Filter by specific job requisition IDs. Leave empty to monitor all job postings.
>
> **job\_site** `array`
>
> Filter job postings by job site IDs. Leave empty to monitor all sites.
>
> **limit** `integer`
>
> Maximum number of job postings to fetch in each poll (1-100)
>
> #### Payload
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **job\_posting** `object` *required*
>
> The newly posted job

> [accordion] Prospect Profile Changed
>
> **Slug:** `WORKDAY_PROSPECT_PROFILE_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **prospect\_id** `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
>
> **changed\_fields** `array`
>
> List of field names that changed between snapshots
>
> **current\_snapshot** `object` *required*
>
> Current state of the prospect profile
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **previous\_snapshot** `object`
>
> Schema representing a snapshot of a prospect's core profile state.

> [accordion] New Prospect Resume Attachment Added
>
> **Slug:** `WORKDAY_PROSPECT_RESUME_ATTACHMENT_ADDED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **limit** `integer`
>
> Maximum number of attachments to check in each poll (1-100)
>
> **prospect\_id** `string` *required*
>
> The Workday ID of the prospect to monitor for new resume attachments
>
> #### Payload
>
> **attachment** `object` *required*
>
> The newly added resume attachment
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **prospect\_id** `string` *required*
>
> The prospect ID this attachment belongs to

> [accordion] Worker Eligible Absence Type Changed
>
> **Slug:** `WORKDAY_WORKER_ELIGIBLE_ABSENCE_TYPE_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **category** `string`
>
> Optional: Filter by absence type category. Valid values: Leave of Absence Type (17bd6531c90c100016d74f8dfae007d0), Absence Table (17bd6531c90c100016da3f5b554007d2), Time Off (17bd6531c90c100016d4b06f2b8a07ce).
>
> **effective** `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.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **worker\_id** `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
>
> **added\_absence\_types** `array`
>
> List of absence types that the worker became newly eligible for
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **removed\_absence\_types** `array`
>
> List of absence types that the worker is no longer eligible for

> [accordion] Worker Leave of Absence Changed
>
> **Slug:** `WORKDAY_WORKER_LEAVE_OF_ABSENCE_CHANGED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **from\_date** `string`
>
> Optional: Start date for filtering leaves in yyyy-mm-dd format.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **leave\_type** `array`
>
> Optional: Filter by specific leave type IDs. Multiple IDs can be specified to monitor multiple types.
>
> **status** `array`
>
> Optional: Filter by specific status IDs. Use 'Get Leave Status Values' action to retrieve valid status IDs.
>
> **to\_date** `string`
>
> Optional: End date for filtering leaves in yyyy-mm-dd format.
>
> **worker\_id** `string` *required*
>
> The Workday ID of the worker to monitor. This can be obtained from actions like 'Get Current User' or 'List Workers'.
>
> #### Payload
>
> **change\_type** `string` *required*
>
> Type of change: 'created', 'updated', or 'deleted'
>
> **changed\_fields** `array`
>
> List of fields that changed for updated records (e.g., \['status', 'estimatedLastDayOfLeave'])
>
> **current\_leave** `object`
>
> Schema for leave of absence details.
>
> **leave\_id** `string` *required*
>
> The unique ID of the leave of absence record that changed
>
> **previous\_leave** `object`
>
> Schema for leave of absence details.

> [accordion] Worker Leave of Absence Created
>
> **Slug:** `WORKDAY_WORKER_LEAVE_OF_ABSENCE_CREATED_TRIGGER`
>
> **Type:** poll
>
> Triggers 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
>
> **from\_date** `string`
>
> Optional: Only monitor leaves starting from this date onwards (yyyy-mm-dd format). Useful for filtering historical leaves.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **leave\_type** `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.
>
> **limit** `integer`
>
> Maximum number of leave records to fetch in each poll (1-100). Default is 50.
>
> **status** `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.
>
> **worker\_id** `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
>
> **event\_type** `string`
>
> Type of event that occurred
>
> **leave\_of\_absence** `object` *required*
>
> The newly created leave of absence record
