> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# workday-common
> Workday Common - workers, organizations, currencies, supervisory organizations, job changes
**Server path:** `/workday-common` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| [`workday_common_get_businesstitlechanges_by_id`](#workday_common_get_businesstitlechanges_by_id) | Retrieves a business title change instance. |
| [`workday_common_get_currencies`](#workday_common_get_currencies) | Retrieves a collection of currencies. |
| [`workday_common_get_currencies_by_id`](#workday_common_get_currencies_by_id) | Retrieves a currency instance. |
| [`workday_common_get_customers_by_id`](#workday_common_get_customers_by_id) | Retrieves a customer instance. |
| [`workday_common_get_customers_by_id_activities`](#workday_common_get_customers_by_id_activities) | Retrieves a collection of activities for a specific customer. |
| [`workday_common_get_customers_by_id_activities_by_subresourceid`](#workday_common_get_customers_by_id_activities_by_subresourceid) | Retrieves an activity instance for a specific customer. |
| [`workday_common_get_jobchangereasons`](#workday_common_get_jobchangereasons) | Retrieves a collection of job change reasons. |
| [`workday_common_get_jobchangereasons_by_id`](#workday_common_get_jobchangereasons_by_id) | Retrieves a job change reason instance. |
| [`workday_common_get_organizations`](#workday_common_get_organizations) | Retrieves a collection of organizations. |
| [`workday_common_get_organizations_by_id`](#workday_common_get_organizations_by_id) | Retrieves an organization instance. |
| [`workday_common_get_organizationtypes`](#workday_common_get_organizationtypes) | Retrieves a collection of organization types. |
| [`workday_common_get_organizationtypes_by_id`](#workday_common_get_organizationtypes_by_id) | Retrieves an organization type instance. |
| [`workday_common_get_supervisoryorganizations`](#workday_common_get_supervisoryorganizations) | Retrieves a collection of supervisory organizations. |
| [`workday_common_get_supervisoryorganizations_by_id`](#workday_common_get_supervisoryorganizations_by_id) | Retrieves a supervisory organization instance. |
| [`workday_common_get_supervisoryorganizations_by_id_workers`](#workday_common_get_supervisoryorganizations_by_id_workers) | Retrieves a collection of workers for a specific supervisory organization. |
| [`workday_common_get_supervisoryorganizations_by_id_workers_by_subresourceid`](#workday_common_get_supervisoryorganizations_by_id_workers_by_subresourceid) | Retrieves a worker instance for a specific supervisory organization. |
| [`workday_common_get_workers`](#workday_common_get_workers) | Retrieves a collection of workers. |
| [`workday_common_get_workers_by_id`](#workday_common_get_workers_by_id) | Retrieves a worker instance. |
| [`workday_common_get_workers_by_id_businesstitlechanges`](#workday_common_get_workers_by_id_businesstitlechanges) | Retrieves a collection of business title changes for a specific worker. |
| [`workday_common_get_workers_by_id_businesstitlechanges_by_subresourceid`](#workday_common_get_workers_by_id_businesstitlechanges_by_subresourceid) | Retrieves a business title change instance for a specific worker. |
| [`workday_common_get_workers_by_id_directreports`](#workday_common_get_workers_by_id_directreports) | Retrieves a collection of direct reports for a specific worker. |
| [`workday_common_get_workers_by_id_directreports_by_subresourceid`](#workday_common_get_workers_by_id_directreports_by_subresourceid) | Retrieves a direct report instance for a specific worker. |
| [`workday_common_get_workers_by_id_history`](#workday_common_get_workers_by_id_history) | Retrieves a collection of history items for a specific worker. |
| [`workday_common_get_workers_by_id_history_by_subresourceid`](#workday_common_get_workers_by_id_history_by_subresourceid) | Retrieves a history instance for a specific worker. |
| [`workday_common_get_workers_by_id_inboxtasks`](#workday_common_get_workers_by_id_inboxtasks) | Retrieves a collection of inbox tasks for a specific worker. |
| [`workday_common_get_workers_by_id_inboxtasks_by_subresourceid`](#workday_common_get_workers_by_id_inboxtasks_by_subresourceid) | Retrieves an inbox task instance for a specific worker. |
| [`workday_common_get_workers_by_id_organizations`](#workday_common_get_workers_by_id_organizations) | Retrieves a collection of organizations for a specific worker. |
| [`workday_common_get_workers_by_id_organizations_by_subresourceid`](#workday_common_get_workers_by_id_organizations_by_subresourceid) | Retrieves an organization instance for a specific worker. |
| [`workday_common_get_workers_by_id_payslips`](#workday_common_get_workers_by_id_payslips) | Retrieves a collection of pay slips for a specific worker. |
| [`workday_common_get_workers_by_id_payslips_by_subresourceid`](#workday_common_get_workers_by_id_payslips_by_subresourceid) | Retrieves a pay slip instance for a specific worker. |
| [`workday_common_get_workers_by_id_supervisoryorganizationsmanaged`](#workday_common_get_workers_by_id_supervisoryorganizationsmanaged) | Retrieves a collection of supervisory organizations managed by a specific worker. |
| [`workday_common_get_workers_by_id_supervisoryorganizationsmanaged_by_subresourceid`](#workday_common_get_workers_by_id_supervisoryorganizationsmanaged_by_subresourceid) | Retrieves a supervisory organization managed by a specific worker. |
| [`workday_common_get_workers_by_id_timeoffentries`](#workday_common_get_workers_by_id_timeoffentries) | Retrieves a collection of time off entries for a specific worker. |
| [`workday_common_get_workers_by_id_timeoffentries_by_subresourceid`](#workday_common_get_workers_by_id_timeoffentries_by_subresourceid) | Retrieves a time off entry for a specific worker. |
| [`workday_common_get_workers_by_id_timeoffplans`](#workday_common_get_workers_by_id_timeoffplans) | Retrieves a collection of time off plans for a specific worker. |
| [`workday_common_get_workers_by_id_timeoffplans_by_subresourceid`](#workday_common_get_workers_by_id_timeoffplans_by_subresourceid) | Retrieves a particular time off plan for a specific worker. |
| [`workday_common_post_workers_by_id_businesstitlechanges`](#workday_common_post_workers_by_id_businesstitlechanges) | Creates a business title change instance with the specified data. |
| [`workday_common_post_workers_by_id_businesstitlechanges_me`](#workday_common_post_workers_by_id_businesstitlechanges_me) | \Secured by:\ Change My Business Title \Scope:\ Staffing |
| [`workday_common_post_workers_by_id_jobchanges`](#workday_common_post_workers_by_id_jobchanges) | Creates a job change instance with the specified data. |
***
## workday\_common\_get\_businesstitlechanges\_by\_id
Retrieves a business title change instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_currencies
Retrieves a collection of currencies.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID"
]
}
```
***
## workday\_common\_get\_currencies\_by\_id
Retrieves a currency instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_customers\_by\_id
Retrieves a customer instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_customers\_by\_id\_activities
Retrieves a collection of activities for a specific customer.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `fromDate` | string | No | — | Start date for filtering (inclusive) |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
| `toDate` | string | No | — | End date for filtering (inclusive) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"fromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
},
"toDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_customers\_by\_id\_activities\_by\_subresourceid
Retrieves an activity instance for a specific customer.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_jobchangereasons
Retrieves a collection of job change reasons.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID"
]
}
```
***
## workday\_common\_get\_jobchangereasons\_by\_id
Retrieves a job change reason instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_organizations
Retrieves a collection of organizations.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
| `organizationType` | string | No | — | Reference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
},
"organizationType": {
"type": "string",
"description": "Reference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type."
}
},
"required": [
"PCID"
]
}
```
***
## workday\_common\_get\_organizations\_by\_id
Retrieves an organization instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_organizationtypes
Retrieves a collection of organization types.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID"
]
}
```
***
## workday\_common\_get\_organizationtypes\_by\_id
Retrieves an organization type instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_supervisoryorganizations
Retrieves a collection of supervisory organizations.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID"
]
}
```
***
## workday\_common\_get\_supervisoryorganizations\_by\_id
Retrieves a supervisory organization instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_supervisoryorganizations\_by\_id\_workers
Retrieves a collection of workers for a specific supervisory organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_supervisoryorganizations\_by\_id\_workers\_by\_subresourceid
Retrieves a worker instance for a specific supervisory organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers
Retrieves a collection of workers.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `includeTerminatedWorkers` | boolean | No | — | Include terminated workers in the output |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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 | No | — | The search value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includeTerminatedWorkers": {
"type": "boolean",
"description": "Include terminated workers in the output"
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "The search value"
}
},
"required": [
"PCID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id
Retrieves a worker instance.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_businesstitlechanges
Retrieves a collection of business title changes for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_businesstitlechanges\_by\_subresourceid
Retrieves a business title change instance for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_directreports
Retrieves a collection of direct reports for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_directreports\_by\_subresourceid
Retrieves a direct report instance for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_history
Retrieves a collection of history items for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_history\_by\_subresourceid
Retrieves a history instance for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_inboxtasks
Retrieves a collection of inbox tasks for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_inboxtasks\_by\_subresourceid
Retrieves an inbox task instance for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_organizations
Retrieves a collection of organizations for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_organizations\_by\_subresourceid
Retrieves an organization instance for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_payslips
Retrieves a collection of pay slips for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_payslips\_by\_subresourceid
Retrieves a pay slip instance for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_supervisoryorganizationsmanaged
Retrieves a collection of supervisory organizations managed by a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_supervisoryorganizationsmanaged\_by\_subresourceid
Retrieves a supervisory organization managed by a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_timeoffentries
Retrieves a collection of time off entries for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_timeoffentries\_by\_subresourceid
Retrieves a time off entry for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_timeoffplans
Retrieves a collection of time off plans for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `limit` | integer | No | — | The maximum number of objects in a single response. The default is 20. The maximum is 100. |
| `offset` | integer | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"limit": {
"type": "integer",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
},
"offset": {
"type": "integer",
"description": "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."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_get\_workers\_by\_id\_timeoffplans\_by\_subresourceid
Retrieves a particular time off plan for a specific worker.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `subresourceID` | string | Yes | — | The Workday ID of the subresource. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"subresourceID": {
"type": "string",
"description": "The Workday ID of the subresource."
}
},
"required": [
"PCID",
"ID",
"subresourceID"
]
}
```
***
## workday\_common\_post\_workers\_by\_id\_businesstitlechanges
Creates a business title change instance with the specified data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `descriptor` | string | No | — | The display name of the instance |
| `href` | string | No | — | A link to the instance |
| `id` | string | No | — | Workday Id or Reference Id of the instance. |
| `proposedBusinessTitle` | string | No | — | The new business title for the \~worker\~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"descriptor": {
"type": "string",
"description": "The display name of the instance"
},
"href": {
"type": "string",
"description": "A link to the instance"
},
"id": {
"type": "string",
"description": "Workday Id or Reference Id of the instance."
},
"proposedBusinessTitle": {
"type": "string",
"description": "The new business title for the \\~worker\\~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_post\_workers\_by\_id\_businesstitlechanges\_me
\Secured by:\ Change My Business Title \Scope:\ Staffing
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `descriptor` | string | No | — | The display name of the instance |
| `href` | string | No | — | A link to the instance |
| `id` | string | No | — | Workday Id or Reference Id of the instance. |
| `proposedBusinessTitle` | string | No | — | The new business title for the \~worker\~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"descriptor": {
"type": "string",
"description": "The display name of the instance"
},
"href": {
"type": "string",
"description": "A link to the instance"
},
"id": {
"type": "string",
"description": "Workday Id or Reference Id of the instance."
},
"proposedBusinessTitle": {
"type": "string",
"description": "The new business title for the \\~worker\\~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name."
}
},
"required": [
"PCID",
"ID"
]
}
```
***
## workday\_common\_post\_workers\_by\_id\_jobchanges
Creates a job change instance with the specified data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ID` | string | Yes | — | The Workday ID of the resource. |
| `descriptor` | string | No | — | The display name of the instance |
| `effective` | string | No | — | The date this business process takes effect. |
| `href` | string | No | — | A link to the instance |
| `id` | string | No | — | Workday Id or Reference Id of the instance. |
| `jobChangeReason` | object | No | — | Returns the reason used in a Change Job business process. |
| `moveManagersTeam` | boolean | No | — | Returns a boolean that indicates whether teams reporting to the \~Manager\~ moved with them during the Change Job Event. |
| `proposedOrganizations` | any\[] | No | — | Contains the organizations with staffing behavior that are assigned to the position as a result of this event. All staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit). |
| `supervisoryOrganization` | object | No | — | The \~supervisory organization\~ for the \~worker\~ as of the effective date. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The Workday ID of the resource."
},
"descriptor": {
"type": "string",
"description": "The display name of the instance"
},
"effective": {
"type": "string",
"description": "The date this business process takes effect."
},
"href": {
"type": "string",
"description": "A link to the instance"
},
"id": {
"type": "string",
"description": "Workday Id or Reference Id of the instance."
},
"jobChangeReason": {
"description": "Returns the reason used in a Change Job business process."
},
"moveManagersTeam": {
"type": "boolean",
"description": "Returns a boolean that indicates whether teams reporting to the \\~Manager\\~ moved with them during the Change Job Event."
},
"proposedOrganizations": {
"type": "array",
"description": "Contains the organizations with staffing behavior that are assigned to the position as a result of this event. All staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit)."
},
"supervisoryOrganization": {
"description": "The \\~supervisory organization\\~ for the \\~worker\\~ as of the effective date."
}
},
"required": [
"PCID",
"ID"
]
}
```