staffing

Workday staffing and workforce management API

community.workday.com/api ↗

Version

OpenAPI

3.0.0

Endpoints

144

Schemas

214

93

Quality

Updated

3 days ago

Hr hr workforce enterprise

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://<tenantHostname>/staffing/v6

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Workers 2 endpoints

DELETE /workers/{ID}/checkInTopics/{subresourceID} Deletes an existing Check-In topic instance.

Deletes an existing Check-In topic instance with the specified ID. This can only be done by the creater of the Check-In topic.

This endpoint is equivalent to the Delete Check-In Topic task in Workday.

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

operationId: Workers_deleteCheckInTopic

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.
subresourceID	path	required	string	The Workday ID of the subresource.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data. Deleting resource.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A160 | You can only delete Check-In topics that you have created.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

DELETE /workers/{ID}/checkInTopics/{subresourceID}

DELETE /workers/{ID}/checkIns/{subresourceID} Deletes an existing Check-In instance.

Deletes an existing Check-In instance with the specified ID. This can only be done by the creater of the Check-In.

This endpoint is equivalent to the Delete Check-In task in Workday.

Secured by: Self-Service: Check-Ins

Scope: Performance Enablement

operationId: Workers_deleteCheckIn

Parameters

Name	In	Required	Type	Description
ID	path	required	string	The Workday ID of the resource.
subresourceID	path	required	string	The Workday ID of the subresource.

Responses

default

An error occurred.

200

Successful response. A successful response can return no matched data. Deleting resource.

400

Invalid request. (https://community.workday.com/rest/error-messages)
Error Code | Validation Message
— | —
A160 | You can only delete Check-Ins that you have created.

401

Invalid resource or operation. (https://community.workday.com/rest/error-messages)

403

User has insufficient permissions. (https://community.workday.com/rest/error-messages)

404

Resource not found. (https://community.workday.com/rest/error-messages)

DELETE /workers/{ID}/checkIns/{subresourceID}

Load more endpoints

Schemas

object ERROR_MODEL_REFERENCE

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change"
    },
    "path": {
      "type": "string",
      "description": "The path of the field related to the error"
    },
    "error": {
      "type": "string",
      "description": "A description of the error"
    },
    "field": {
      "type": "string",
      "description": "The field related to the error"
    }
  }
}

array FACETS_MODEL_REFERENCE

{
  "type": "array",
  "items": {
    "type": "object",
    "readOnly": true,
    "properties": {
      "values": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "id"
          ],
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
              "description": "wid / id / reference id"
            },
            "href": {
              "type": "string",
              "readOnly": true,
              "description": "A link to the instance"
            },
            "count": {
              "type": "integer",
              "format": "int32",
              "description": "The number of instances returned by this facet"
            },
            "descriptor": {
              "type": "string",
              "description": "A description of the facet"
            }
          }
        },
        "description": "the facet values"
      },
      "descriptor": {
        "type": "string",
        "description": "A description of the facet"
      },
      "facetParameter": {
        "type": "string",
        "description": "The alias used to select the facet"
      }
    },
    "description": "This object represents the possible facets for this resource"
  }
}

object INSTANCE_MODEL_REFERENCE

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
      "description": "wid / id / reference id"
    },
    "href": {
      "type": "string",
      "readOnly": true,
      "description": "A link to the instance"
    },
    "descriptor": {
      "type": "string",
      "readOnly": true,
      "description": "A description of the instance"
    }
  }
}

object JobChangesGetAdministrativeOptionsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobAdministrativeDetailsData_f8f20079bc5a1000089ccb7f6a8800ea"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetBusinessTitleResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobBusinessTitle_3db8095ffa18100013a5f96969ca0102"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetCommentByIdResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/comments_7d98fd55aeee100022968e52a1b31c60"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetContractOptionsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobContractDetailsData_27ec818d10d010000386ce823ac20107"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetJobClassificationResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobJobClassificationData_354103f196361000084489bcb281017f"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetJobProfileResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobJobProfileData_3db8095ffa18100013f019a27a1f0115"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetLocationInfoResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobLocation_90151d6c4ff110001b4a46091678025c"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetMoveTeamOptionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobMoveTeamData_544fdf5c01da1000238ad82d26d90146"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetOpeningOptionsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobOpeningData_97af9049a5fd10001c4888d654170000"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetPositionByIdResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/changeJobPositionData_dfc4e58f7308100018bd1c459f435221"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobChangesGetStartDetailsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobChangesStartDetailsData_ce861a6a360d10002d40f176b7180020"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobFamiliesListResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobFamilyView_51ed1475e9e6100005d10fcedc5a000a"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobProfilesListCollectionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobProfileSummaryView_7deab99f645f10000b5152ce2d700034"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobsGetCollectionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobData_1bfa8925c50510000ae4479925510026"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object JobsGetWorkspacesResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobWorkspaceData_1005157e3d631000144205466a6c13d3"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object MULTIPLE_INSTANCE_MODEL_REFERENCE

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
      }
    },
    "total": {
      "type": "integer"
    }
  }
}

object OrganizationAssignmentChangesGetBusinessUnitResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesBusinessUnitData_5aabf8e28cb310002520b2a2b31d0365"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCommentResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/comments_7d98fd55aeee100022968e52a1b31c60"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCompanyResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCompanyData_652d516fdff41000086e0b9c96950354"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCostCenterResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCostCenterData_5aabf8e28cb3100010a999db2700024e"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCostingOrganizationsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCostingData_a18edb56aca0100014a4a09dc57e045a"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetCustomOrganizationsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesCustomOrganizationDetailsData_53cd2b632146100011e9bf4e7041551f"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetRegionResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesRegionData_a18edb56aca0100006997e68e5780373"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object OrganizationAssignmentChangesGetStartDetailsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/organizationAssignmentChangesStartDetailsData_90009f2bfc49100017b10cd07d19063b"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object SupervisoryOrganizationsGetByIdResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/supervisoryOrganizationView_a02c2e1916fa100009e137235f1f0018"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object SupervisoryOrganizationsGetMembersResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jobData_1bfa8925c50510000ae4479925510026"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object SupervisoryOrganizationsGetOrgChartResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/orgChartView_643e3a12629710000554e0338e670044"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object VALIDATION_ERROR_MODEL_REFERENCE

{
  "allOf": [
    {
      "type": "object",
      "required": [
        "error"
      ],
      "properties": {
        "error": {
          "type": "string",
          "description": "A description of the error"
        },
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          },
          "description": "An array of validation errors"
        }
      }
    }
  ]
}

object WorkersGetCheckInTopicsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/checkInTopicsSummary_d81c816de26f10000ef2c5cb2fdd0015"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetCheckInsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/checkInsSummary_b3a69f47a499100010ce6be72bfe001d"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetCollectionStaffingResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workerData_c2466b0778c610000d1936006720000e"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetExplicitSkillsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/displayExplicitSkillRepresentation_d6ca778018011000182fa5be1ae901a8"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetExternalSkillLevelResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/externalSkillLevelDetail_1c67ac98c0f310002706be33dcdb0000"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetServiceDatesResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/serviceDatesData_6b1db753fd82100027b0c8519c860018"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object WorkersGetSkillItemsResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/skillItemDisplayDefinition_4b4b7d34b4a21000301eaf52086700d8"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64"
    }
  }
}

object action_38ff08ab6736100010816009079d0126

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "a set containing no instances"
}

object assignmentType_23929e1f68ca10000d6940d6bde56963

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "For a past or current business process, the value of the Assignment Type field that is being (or was) proposed in the process.",
  "x-conditionally-hidden": true,
  "x-conditionally-required": true
}

object associatedCheckInDetail_3267c0ba92a0100016ed105476ad03c4

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        }
      }
    }
  ]
}

object associatedCheckInTopicDetail_316b5a26cc3c100010a01184c23902ea

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        }
      }
    }
  ]
}

object associatedCheckInsSummary_d81c816de26f10000f7a29ea89140020

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        },
        "date": {
          "type": "string",
          "format": "date",
          "example": "2024-03-23T07:00:00.000Z",
          "description": "Date of check-in.",
          "x-workday-type": "Date"
        },
        "archived": {
          "type": "boolean",
          "example": true,
          "description": "Indicates that the check-in is archived.",
          "x-workday-type": "Boolean"
        }
      }
    }
  ]
}

object associatedTopicsSummary_b3a69f47a4991000171aae4c5a810040

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        },
        "name": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "description": "Topic name.",
          "x-workday-type": "Text"
        },
        "archived": {
          "type": "boolean",
          "example": true,
          "description": "Indicates that the topic is archived.",
          "x-workday-type": "Boolean"
        }
      }
    }
  ]
}

object businessProcessParameters_23782ad3f54110002073aab65def00fb

{
  "allOf": [
    {
      "$ref": "#/components/schemas/businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265"
    },
    {}
  ],
  "description": "The Action Event instance to be used with businessProcessLinkable linked service representations."
}

object businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265

{
  "allOf": [
    {
      "type": "object",
      "required": [
        "action"
      ],
      "properties": {
        "for": {
          "$ref": "#/components/schemas/for_5d688bd57bb910001815ab3dd10024a9"
        },
        "action": {
          "$ref": "#/components/schemas/action_38ff08ab6736100010816009079d0126"
        },
        "comment": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "description": "Returns a null.",
          "x-workday-type": "Text"
        },
        "comments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/comments_86093b8a932f10001499f356ff83012e"
          },
          "readOnly": true,
          "description": "Returns the comments for the current business process.",
          "x-workday-type": "Multi-instance"
        },
        "attachments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/eventAttachmentsForToolbar_43b30ba735b8100011ee4767246d0143"
          },
          "description": "Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.",
          "x-workday-type": "Multi-instance"
        },
        "overallStatus": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "readOnly": true,
          "description": "The current status of the business process.  For example: Successfully Completed, Denied, Terminated.",
          "x-workday-type": "Text"
        },
        "transactionStatus": {
          "$ref": "#/components/schemas/transactionStatus_7457adcbe0fa1000089b63ab3a510000"
        },
        "warningValidations": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "readOnly": true,
          "description": "Warning message for an action event triggered by a condition.",
          "x-workday-type": "Text"
        },
        "criticalValidations": {
          "type": "string",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "readOnly": true,
          "description": "Validation message for an action event triggered by a condition.",
          "x-workday-type": "Text"
        },
        "overallBusinessProcess": {
          "$ref": "#/components/schemas/overallBusinessProcess_5d688bd57bb910001815ab49927724aa"
        }
      }
    }
  ]
}

object businessProcessParameters_5afc0b4b5a4610002aaebb8180cd2261

{
  "allOf": [
    {
      "$ref": "#/components/schemas/businessProcessParameters_2dcd9a4882b210000f7b2e0a85982265"
    },
    {}
  ],
  "description": "The Action Event instance to be used with businessProcessLinkable linked service representations."
}

object businessUnit_5aabf8e28cb310002520b2aabc470366

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "The new business unit for the \\~worker\\~ as of the effective date.",
  "x-conditionally-hidden": true,
  "x-conditionally-required": true
}

object category_43b30ba735b8100011ee4781a9d50146

{
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {}
  ],
  "description": "Returns the category of a Business Process Attachment."
}

object changeJobAdditionalJobClassificationData_27ec818d10d0100003600115b5200102

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the instance"
        },
        "descriptor": {
          "type": "string",
          "example": "Lorem ipsum dolor sit ame",
          "description": "A preview of the instance"
        }
      }
    }
  ]
}

Load more schemas

Versions

Version	Endpoints	Schemas	Ingested	Status
v6	144	214	2026-05-18	current
v6	144	214	2026-04-16