Workday Tool
Read Workday HCM data — workers, supervisory organizations, and job profiles — via the Workday REST API.
Tool ID
workday-hcm
Credential Required
Yes — a server-refreshed OAuth credential (auth mode: oauth_user). Link an oauth-type credential (mint one with itcli.py /oauth); the InTouch server resolves and refreshes it and hands the tool a live access_token, sent on every request as Authorization: Bearer <token>. The tool never refreshes or stores the token — the server owns the token lifecycle. All requests go to https://{host}/ccx/api — the Workday API host and the tenant come from the task's host and tenant inputs, not the credential.
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
client_id |
string | — | OAuth app client ID |
client_secret |
string | — | OAuth app client secret (if required on refresh) |
token_url |
string | — | Provider OAuth token endpoint — used to refresh |
access_token |
string | — | Required. Current access token — kept fresh by the server; do not edit by hand |
refresh_token |
string | — | Refresh token; enables automatic server-side refresh |
token_type |
string | Bearer |
Token type |
scope |
string | — | Granted OAuth scopes (space-separated) |
expires_at |
string | — | Access-token expiry in epoch seconds (0 = non-expiring) |
Operations
1. list_workers — List workers
Lists workers in the tenant. Calls GET /staffing/v6/{tenant}/workers.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. One of: list_workers, get_worker, list_supervisory_organizations, list_job_profiles |
host |
string | — | Required. Workday API host, e.g. wd2-impl-services1.workday.com or <tenant>.workday.com |
tenant |
string | — | Required. Workday tenant name (the {tenant} segment in the REST path) |
query |
string | — | Optional query params as a JSON object string, e.g. {"limit": 20, "offset": 0} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
2. get_worker — Get a worker
Reads a single worker by id. Calls GET /staffing/v6/{tenant}/workers/{workerId}.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
host |
string | — | Required. Workday API host |
tenant |
string | — | Required. Workday tenant name |
workerId |
string | — | Required. Worker WID/id |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
3. list_supervisory_organizations — List supervisory organizations
Lists supervisory organizations. Calls GET /common/v1/{tenant}/supervisoryOrganizations.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
host |
string | — | Required. Workday API host |
tenant |
string | — | Required. Workday tenant name |
query |
string | — | Optional query params as a JSON object string, e.g. {"limit": 20} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
4. list_job_profiles — List job profiles
Lists job profiles. Calls GET /staffing/v6/{tenant}/jobProfiles.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
host |
string | — | Required. Workday API host |
tenant |
string | — | Required. Workday tenant name |
query |
string | — | Optional query params as a JSON object string, e.g. {"limit": 20} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
License
Requires a per-tool connector license on Department/Enterprise editions (unaffected on Personal/Solo/Team editions). Apply it via the tool's Apply License action.
Self-Contained JAR
The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
completeoperationresultstatuswarning