Workday Recruiting v4 — full pinned service

This reference is readable without JavaScript. Download the OpenAPI document.

Runtime

/api/purple-suite/{instanceId}/contracts/hris/workday

[
  {
    "method": "get",
    "path": "/recruiting/v4/interviews",
    "operationId": "workdayRecruitingGetInterviews"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/interviews/:ID/feedback",
    "operationId": "workdayRecruitingGetInterviewsByIDFeedback"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/interviews/:ID/feedback",
    "operationId": "workdayRecruitingPostInterviewsByIDFeedback"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/interviews/:ID",
    "operationId": "workdayRecruitingGetInterviewsByID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/interviews/:ID/feedback/:subresourceID",
    "operationId": "workdayRecruitingGetInterviewsByIDFeedbackBySubresourceID"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/prospects",
    "operationId": "workdayRecruitingPostProspects"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/educations/:subresourceID",
    "operationId": "workdayRecruitingGetProspectsByIDEducationsBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/languages/:subresourceID",
    "operationId": "workdayRecruitingGetProspectsByIDLanguagesBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/resumeAttachments",
    "operationId": "workdayRecruitingGetProspectsByIDResumeAttachments"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/prospects/:ID/resumeAttachments",
    "operationId": "workdayRecruitingPostProspectsByIDResumeAttachments"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/experiences",
    "operationId": "workdayRecruitingGetProspectsByIDExperiences"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/prospects/:ID/experiences",
    "operationId": "workdayRecruitingPostProspectsByIDExperiences"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/languages",
    "operationId": "workdayRecruitingGetProspectsByIDLanguages"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/prospects/:ID/languages",
    "operationId": "workdayRecruitingPostProspectsByIDLanguages"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/skills/:subresourceID",
    "operationId": "workdayRecruitingGetProspectsByIDSkillsBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/resumeAttachments",
    "operationId": "workdayRecruitingGetProspectsByIDResumeAttachmentsTypeViewFile",
    "discriminator": {
      "kind": "query",
      "operation": "workdayRecruitingGetProspectsByIDResumeAttachmentsTypeViewFile",
      "parameter": "type",
      "value": "viewFile"
    }
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/skills",
    "operationId": "workdayRecruitingGetProspectsByIDSkills"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/prospects/:ID/skills",
    "operationId": "workdayRecruitingPostProspectsByIDSkills"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/experiences/:subresourceID",
    "operationId": "workdayRecruitingGetProspectsByIDExperiencesBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/educations",
    "operationId": "workdayRecruitingGetProspectsByIDEducations"
  },
  {
    "method": "post",
    "path": "/recruiting/v4/prospects/:ID/educations",
    "operationId": "workdayRecruitingPostProspectsByIDEducations"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID",
    "operationId": "workdayRecruitingGetProspectsByID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/resumeAttachments/:subresourceID",
    "operationId": "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceIDTypeViewFile",
    "discriminator": {
      "kind": "query",
      "operation": "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceIDTypeViewFile",
      "parameter": "type",
      "value": "viewFile"
    }
  },
  {
    "method": "get",
    "path": "/recruiting/v4/prospects/:ID/resumeAttachments/:subresourceID",
    "operationId": "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/jobPostings",
    "operationId": "workdayRecruitingGetJobPostings"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/jobPostings/:ID/questionnaire",
    "operationId": "workdayRecruitingGetJobPostingsByIDQuestionnaire"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/jobPostings/:ID/questionnaire/:subresourceID",
    "operationId": "workdayRecruitingGetJobPostingsByIDQuestionnaireBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/jobPostings/:ID/candidateAvailabilityTemplate/:subresourceID",
    "operationId": "workdayRecruitingGetJobPostingsByIDCandidateAvailabilityTemplateBySubresourceID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/jobPostings/:ID",
    "operationId": "workdayRecruitingGetJobPostingsByID"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/jobPostings/:ID/candidateAvailabilityTemplate",
    "operationId": "workdayRecruitingGetJobPostingsByIDCandidateAvailabilityTemplate"
  },
  {
    "method": "get",
    "path": "/recruiting/v4/values/common/countries/",
    "operationId": "workdayRecruitingGetValuesCommonCountries"
  }
]

Credentials

OAuth 2.0 bearer token: Authorization: Bearer <TOKEN>
The painted runtime validates a PurpleSuite instance key in the Workday bearer-token transport.
Credential model: instance-key

Coverage and limitations

{
  "documentScope": "full",
  "runtimeFidelity": "modeled",
  "counts": {
    "operations": 31
  },
  "notes": [
    "All 31 operations in the pinned 2026-07-27 Workday Recruiting v4 artifact are mounted: 0 captured handlers and 31 per-instance repository-backed operations.",
    "Modeled reads return stored resources, relationship-scoped collections, or native 404s; modeled writes provide read-after-write lifecycle behavior and never return request-seeded schema witnesses.",
    "Two artifact paths contain ?type=archive; runtime routing canonicalizes only those exact single-value query discriminators while retaining both official operation identities.",
    "Full means the complete pinned service artifact, not the whole Workday platform.",
    "Explicitly excluded: Workday Web Services (SOAP/WWS); Workday Graph API; Workday Query Language (WQL), a separate Platform API family; Reports-as-a-Service (RaaS) and tenant custom reports; Finance, Payroll, Student, and non-HR Platform REST services; Experimental alpha, beta, and labs services; Tenant-configured actions absent from the pinned public artifacts."
  ]
}

The Recruiting service enables applications to access Workday data about recruiting, such as job postings, prospects, and interviews.

Servers

[
  {
    "url": "/api/purple-suite/{instanceId}/contracts/hris/workday",
    "description": "PurpleSuite Workday-painted instance boundary",
    "variables": {
      "instanceId": {
        "default": "INSTANCE_ID",
        "description": "PurpleSuite instance identifier"
      }
    }
  }
]

Authentication schemes

{
  "OAuth2": {
    "type": "oauth2",
    "flows": {
      "implicit": {
        "authorizationUrl": "https://<tenantAuthorizationHostname>",
        "scopes": {}
      }
    }
  }
}

Each operation lists its security requirements. An empty security array permits an unauthenticated request. Use the scheme and headers declared for the selected contract.

Operations

GET /recruiting/v4/interviews
GET /recruiting/v4/interviews/{ID}/feedback
POST /recruiting/v4/interviews/{ID}/feedback
GET /recruiting/v4/interviews/{ID}
GET /recruiting/v4/interviews/{ID}/feedback/{subresourceID}
POST /recruiting/v4/prospects
GET /recruiting/v4/prospects/{ID}/educations/{subresourceID}
GET /recruiting/v4/prospects/{ID}/languages/{subresourceID}
GET /recruiting/v4/prospects/{ID}/resumeAttachments
POST /recruiting/v4/prospects/{ID}/resumeAttachments
GET /recruiting/v4/prospects/{ID}/experiences
POST /recruiting/v4/prospects/{ID}/experiences
GET /recruiting/v4/prospects/{ID}/languages
POST /recruiting/v4/prospects/{ID}/languages
GET /recruiting/v4/prospects/{ID}/skills/{subresourceID}
GET /recruiting/v4/prospects/{ID}/resumeAttachments?type=viewFile
GET /recruiting/v4/prospects/{ID}/skills
POST /recruiting/v4/prospects/{ID}/skills
GET /recruiting/v4/prospects/{ID}/experiences/{subresourceID}
GET /recruiting/v4/prospects/{ID}/educations
POST /recruiting/v4/prospects/{ID}/educations
GET /recruiting/v4/prospects/{ID}
GET /recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}?type=viewFile
GET /recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}
GET /recruiting/v4/jobPostings
GET /recruiting/v4/jobPostings/{ID}/questionnaire
GET /recruiting/v4/jobPostings/{ID}/questionnaire/{subresourceID}
GET /recruiting/v4/jobPostings/{ID}/candidateAvailabilityTemplate/{subresourceID}
GET /recruiting/v4/jobPostings/{ID}
GET /recruiting/v4/jobPostings/{ID}/candidateAvailabilityTemplate
GET /recruiting/v4/values/common/countries/

GET /recruiting/v4/interviews

Retrieves a collection of interviews. Secured By Domain: Interview Feedback Public API Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "interviews"
  ],
  "description": "Retrieves a collection of interviews.\n\n<b>Secured By Domain:</b> Interview Feedback Public API\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "interviewStatus",
      "in": "query",
      "description": "\"All applicable interview statuses for an Interview event. Statuses can be: \n * AWAITING_ME - An in-progress Interview event is waiting for the logged-in user's feedback. \n * COMPLETED - An Interview event is complete.\n * FEEDBACK_COMPLETE - All interview feedback for this in-progress event was submitted, but the Interview event isn’t awaiting the Make Interview Decision step.\n * NOT_SCHEDULED - An interview hasn't been scheduled for an in-progress Interview event.\n * PENDING_FEEDBACK - An in-progress Interview event is waiting for interviewer feedback.\n * SCHEDULED - An interview is scheduled for an in-progress Interview event.\n * SUBMITTED_FEEDBACK - The logged-in user submitted feedback for an in-progress Interview event.\n * MAKE_INTERVIEW_DECISION - The make an interview decision step for the candidate.\"",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/interviewEventWithJobApplicationJobRequisitionInterviewerDetails_def69f12d55410000f7ec8da36ae005a"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "df78b8e577c910001f381909b55100e6",
  "x-workday-secured-by-domains": [
    "Interview Feedback Public API"
  ]
}

GET /recruiting/v4/interviews/{ID}/feedback

Retrieves interview feedback for the specified ID. Secured By Domain: Interview Feedback Public API Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "interviews"
  ],
  "description": "Retrieves interview feedback for the specified ID.\n\n<b>Secured By Domain:</b> Interview Feedback Public API\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/interviewDetailSummary_def69f12d5541000139a7815aae9008f"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "df78b8e577c910001ba2775bb2e200c8",
  "x-workday-secured-by-domains": [
    "Interview Feedback Public API"
  ]
}

POST /recruiting/v4/interviews/{ID}/feedback

Submits interview details for the processing \~worker\~ with the interviewer's rating and comment. Secured By Domain: Interview Feedback Public API Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "interviews"
  ],
  "description": "Submits interview details for the processing \\~worker\\~ with the interviewer's rating and comment.\n\n<b>Secured By Domain:</b> Interview Feedback Public API\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/interviewDetailSummary_def69f12d5541000139a7815aae9008f"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/interviewDetailSummary_def69f12d5541000139a7815aae9008f"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A129 | You cannot take action on this candidate. |\n| Critical | A130 | Select a valid rating. |\n| Critical | A131 | You cannot submit interview feedback because you are not a part of the interview team. |\n| Critical | A132 | Overall Comment Required (Configure Optional Fields) but not included.  Please contact your administrator. |\n| Critical | A133 | Overall Rating is included but is hidden (Configure Optional Fields).  Please contact your administrator. |\n| Critical | A134 | Overall Comment is included but is hidden (Configure Optional Fields).  Please contact your administrator. |\n| Critical | A135 | Interview feedback task contains competencies, questionnaires, or both; complete feedback using Workday or the Give Interview Feedback URL provided by the API. |\n| Critical | A136 | Overall Rating is Required (Configure Optional Fields) but not included.  Please contact your administrator. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "df78b8e577c91000174144aa747100b1",
  "x-workday-secured-by-domains": [
    "Interview Feedback Public API"
  ]
}

GET /recruiting/v4/interviews/{ID}

Retrieves a collection of interviews. Secured By Domain: Interview Feedback Public API Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "interviews"
  ],
  "description": "Retrieves a collection of interviews.\n\n<b>Secured By Domain:</b> Interview Feedback Public API\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/interviewEventWithJobApplicationJobRequisitionInterviewerDetails_def69f12d55410000f7ec8da36ae005a"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "df78b8e577c910001f381909b55100e6",
  "x-workday-secured-by-domains": [
    "Interview Feedback Public API"
  ]
}

GET /recruiting/v4/interviews/{ID}/feedback/{subresourceID}

Retrieves interview feedback for the specified ID. Secured By Domain: Interview Feedback Public API Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "interviews"
  ],
  "description": "Retrieves interview feedback for the specified ID.\n\n<b>Secured By Domain:</b> Interview Feedback Public API\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/interviewDetailSummary_def69f12d5541000139a7815aae9008f"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "df78b8e577c910001ba2775bb2e200c8",
  "x-workday-secured-by-domains": [
    "Interview Feedback Public API"
  ]
}

POST /recruiting/v4/prospects

Create \~prospects\~.

Creates a single \~prospect\~ instance with the specified data. In the request body, specify at least the required field: candidate.name.country.id. The Recruiting Name Components configuration might require additional fields for candidate.name. To determine additional required fields, see the Recruiting Name Components tab on the Maintain Name Components by \~Country\~ task. Secured By Domain: Create External Prospects, Set Up: External Career Site Access Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Create \\~prospects\\~.",
  "description": "Creates a single \\~prospect\\~ instance with the specified data. In the request body, specify at least the required field: candidate.name.country.id. The Recruiting Name Components configuration might require additional fields for candidate.name. To determine additional required fields, see the Recruiting Name Components tab on the Maintain Name Components by \\~Country\\~ task.\n\n<b>Secured By Domain:</b> Create External Prospects, Set Up: External Career Site Access\n\n<b>Scope:</b> Recruiting",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/prospectSummary_7657284bd7781000178a3bf6e17f001a"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/prospectSummary_7657284bd7781000178a3bf6e17f001a"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A249 | You must enter the prospect’s email address or phone number. |\n| Critical | A255 | Enter referral as the source when you enter referred by. |\n| Critical | A256 | Enter a name. |\n| Critical | A268 | Enter the referral for the prospect. |\n| Critical | A269 | Enter an email address in this format: xxx@yy.com. |\n| Critical | A274 | Enter a valid format for Phone Number. |\n| Critical | A278 | Enter active candidate pools. |\n| Critical | A284 | Enter active candidate tags. |\n| Critical | A288 | Enter a phone number in the valid format: [PhoneValidationMessage] |\n| Critical | A673 | The Phone Device Type that you specified must be Active. |\n| Critical | A820 | Specify a value for Phone Device Type. |\n| Critical | A821 | You can't specify a Phone Device Type that's Hidden for Recruiting. |\n| Critical | A822 | Specify a value for Phone Number. |\n| Critical | A823 | Specify a value for Country Phone Code. |\n| Critical | A2517 | The email address you entered is invalid. Enter a valid email address. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "50be5081f82e10000a3259d6e22d05b7",
  "x-workday-secured-by-domains": [
    "Create External Prospects",
    "Set Up: External Career Site Access"
  ]
}

GET /recruiting/v4/prospects/{ID}/educations/{subresourceID}

Retrieves a single education instance for a \~prospect\~.

Retrieves the education with specified ID for the specified \~prospect\~. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves a single education instance for a \\~prospect\\~.",
  "description": "Retrieves the education with specified ID for the specified \\~prospect\\~.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A261 | Enter a school name. |\n| Critical | A283 | Enter a last year attended that is after the first year attended. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "9727f970aa231000060528416b7b0016",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/languages/{subresourceID}

Retrieves a single language instance for a \~prospect\~.

Retrieves the language with the specified ID for the specified \~prospect\~. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves a single language instance for a \\~prospect\\~.",
  "description": "Retrieves the language with the specified ID for the specified \\~prospect\\~.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "ecf7ccfb11c110002805608ea5d80015",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/resumeAttachments

Retrieves attached resumes for a single \~prospect\~ instance.

Retrieves attached resumes for the \~prospect\~ with the specified ID. Secured By Domain: Candidate Data: Attachments Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves attached resumes for a single \\~prospect\\~ instance.",
  "description": "Retrieves attached resumes for the \\~prospect\\~ with the specified ID.\n\n<b>Secured By Domain:</b> Candidate Data: Attachments\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/resumeAttachmentDetailsView_134c3544d220100007f0f9b541a400a5"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b627485bd061100019eefb6f66010180",
  "x-workday-secured-by-domains": [
    "Candidate Data: Attachments"
  ]
}

POST /recruiting/v4/prospects/{ID}/resumeAttachments

Creates resume attachments for a \~prospect\~.

Creates a single resume attachment instance with the specified data. In the request body, specify at least these required fields: fileName, attachmentContent. Secured By Domain: Create External Prospects, Set Up: External Career Site Access Scope: Recruiting Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Creates resume attachments for a \\~prospect\\~.",
  "description": "Creates a single resume attachment instance with the specified data. In the request body, specify at least these required fields: fileName, attachmentContent.\n\n<b>Secured By Domain:</b> Create External Prospects, Set Up: External Career Site Access\n\n<b>Scope:</b> Recruiting\n\nContains attachment(s)",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/resumeAttachmentDetailsCreate_ee22ee09075410000346b5ebfa2303e4"
        },
        "x-workday-multipart-root-part-name": "jsonData"
      }
    },
    "x-workday-multipart-root-part-name": "jsonData"
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/resumeAttachmentDetailsCreate_ee22ee09075410000346b5ebfa2303e4"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A246 | One of the following file extensions must be used: [allowed file extensions]. |\n| Critical | A252 | Enter a file name. |\n| Critical | A270 | Select a file to upload. |\n| Critical | - | The file size should not exceed [file size]MB. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b627485bd061100019eefbc59fe90182",
  "x-workday-secured-by-domains": [
    "Create External Prospects",
    "Set Up: External Career Site Access"
  ]
}

GET /recruiting/v4/prospects/{ID}/experiences

Retrieves the work experience of a single \~prospect\~ instance.

Retrieves the work experience of the \~prospect\~ with the specified ID. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves the work experience of a single \\~prospect\\~ instance.",
  "description": "Retrieves the work experience of the \\~prospect\\~ with the specified ID.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b4dba3cbddc710001bf375eb8400001c",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

POST /recruiting/v4/prospects/{ID}/experiences

Creates experiences for a \~prospect\~.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: companyName, title, startYear. Secured By Domain: Create External Prospects Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Creates experiences for a \\~prospect\\~.",
  "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100.  In the request body, specify at least these required fields: companyName, title, startYear.\n\n<b>Secured By Domain:</b> Create External Prospects\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A240 | Enter end year when you enter the end month. |\n| Critical | A247 | Enter a title. |\n| Critical | A253 | Enter a number from 1 to 12 for end month. |\n| Critical | A258 | Enter a start year. |\n| Critical | A271 | Enter an end month and end year that occur on or after the start month and start year. |\n| Critical | A282 | Enter a company name. |\n| Critical | A286 | Enter a number from 1 to 12 for start month. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b4dba3cbddc710001bf375af9e44001b",
  "x-workday-secured-by-domains": [
    "Create External Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/languages

Retrieves the languages of a single \~prospect\~ instance.

Retrieves the languages of the \~prospect\~ with the specified ID. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves the languages of a single \\~prospect\\~ instance.",
  "description": "Retrieves the languages of the \\~prospect\\~ with the specified ID.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "ecf7ccfb11c110002805608ea5d80015",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

POST /recruiting/v4/prospects/{ID}/languages

Creates languages for a \~prospect\~.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: language.id, abilities, abilities.abilityType. Secured By Domain: Create External Prospects Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Creates languages for a \\~prospect\\~.",
  "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: language.id, abilities, abilities.abilityType.\n\n<b>Secured By Domain:</b> Create External Prospects\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A242 | Enter only 1 ability type for the same language. |\n| Critical | A263 | Enter a language. |\n| Critical | A267 | At least one ability for this language is required. |\n| Critical | A290 | Duplicate language entries are not allowed. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "ecf7ccfb11c110002afc9babda82002e",
  "x-workday-secured-by-domains": [
    "Create External Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/skills/{subresourceID}

Retrieves a single skill instance for a \~prospect\~.

Retrieves the skill with the specified ID for the specified \~prospect\~. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves a single skill instance for a \\~prospect\\~.",
  "description": "Retrieves the skill with the specified ID for the specified \\~prospect\\~.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/candidateSkillItemDetails_2705750e957f10002beca80792940019"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "d1f5b73501871000123b3f69018f005e",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/resumeAttachments?type=viewFile

Secured By Domain: Candidate Data: Attachments Scope: Recruiting Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "description": "\n\n<b>Secured By Domain:</b> Candidate Data: Attachments\n\n<b>Scope:</b> Recruiting\n\nContains attachment(s)",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/resumeAttachmentFileView_ee7318fbf39e10001e321c67d42300c0"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b627485bd061100019eefbbb0d6c0181",
  "x-workday-secured-by-domains": [
    "Candidate Data: Attachments"
  ]
}

GET /recruiting/v4/prospects/{ID}/skills

Retrieves the skills of a single \~prospect\~ instance.

Retrieves the skills of the \~prospect\~ with the specified ID. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves the skills of a single \\~prospect\\~ instance.",
  "description": "Retrieves the skills of the \\~prospect\\~ with the specified ID.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/candidateSkillItemDetails_2705750e957f10002beca80792940019"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "d1f5b73501871000123b3f69018f005e",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

POST /recruiting/v4/prospects/{ID}/skills

Creates skills for a \~prospect\~.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: name. Secured By Domain: Create External Prospects Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Creates skills for a \\~prospect\\~.",
  "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: name.\n\n<b>Secured By Domain:</b> Create External Prospects\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/candidateSkillItemDetails_2705750e957f10002beca80792940019"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/candidateSkillItemDetails_2705750e957f10002beca80792940019"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A257 | Enter a skill name. |\n| Critical | A259 | You cannot enter duplicate skills. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "2705750e957f10002bc3d403249c0017",
  "x-workday-secured-by-domains": [
    "Create External Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/experiences/{subresourceID}

Retrieves a single experience instance for a \~prospect\~.

Retrieves the work experience with the specified ID for the specified \~prospect\~. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves a single experience instance for a \\~prospect\\~.",
  "description": "Retrieves the work experience with the specified ID for the specified \\~prospect\\~.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b4dba3cbddc710001bf375eb8400001c",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}/educations

Retrieves the education of a single \~prospect\~ instance.

Retrieves the education of the \~prospect\~ with the specified ID. Secured By Domain: Prospects Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves the education of a single \\~prospect\\~ instance.",
  "description": "Retrieves the education of the \\~prospect\\~ with the specified ID.\n\n<b>Secured By Domain:</b> Prospects\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A261 | Enter a school name. |\n| Critical | A283 | Enter a last year attended that is after the first year attended. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "9727f970aa231000060528416b7b0016",
  "x-workday-secured-by-domains": [
    "Prospects"
  ]
}

POST /recruiting/v4/prospects/{ID}/educations

Creates educations for a \~prospect\~.

To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify "bulk=true" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100. In the request body, specify at least these required fields: schoolName. Secured By Domain: Create External Prospects Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Creates educations for a \\~prospect\\~.",
  "description": "To create a single instance, specify the single JSON object in the request body. To create multiple instances, specify \"bulk=true\" as a query parameter. You must specify the JSON object collection in data[ ] in the request body. The maximum collection size is 100.  In the request body, specify at least these required fields: schoolName.\n\n<b>Secured By Domain:</b> Create External Prospects\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/candidateEducationDetails_9727f970aa231000052ae7db3fc0000b"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A261 | Enter a school name. |\n| Critical | A283 | Enter a last year attended that is after the first year attended. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "9727f970aa231000052be822d809000d",
  "x-workday-secured-by-domains": [
    "Create External Prospects"
  ]
}

GET /recruiting/v4/prospects/{ID}

Retrieves a single \~prospect\~ instance.

Retrieves the \~prospect\~ with the specified ID. Secured By Domain: Prospects, Set Up: External Career Site Access Scope: Recruiting, Talent Pipeline

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves a single \\~prospect\\~ instance.",
  "description": "Retrieves the \\~prospect\\~ with the specified ID.\n\n<b>Secured By Domain:</b> Prospects, Set Up: External Career Site Access\n\n<b>Scope:</b> Recruiting, Talent Pipeline",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/prospectSummary_7657284bd7781000178a3bf6e17f001a"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "ef3d700eb59610001e2f0dcf2ea90013",
  "x-workday-secured-by-domains": [
    "Prospects",
    "Set Up: External Career Site Access"
  ]
}

GET /recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}?type=viewFile

Secured By Domain: Candidate Data: Attachments Scope: Recruiting Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "description": "\n\n<b>Secured By Domain:</b> Candidate Data: Attachments\n\n<b>Scope:</b> Recruiting\n\nContains attachment(s)",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/resumeAttachmentFileView_ee7318fbf39e10001e321c67d42300c0"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b627485bd061100019eefbbb0d6c0181",
  "x-workday-secured-by-domains": [
    "Candidate Data: Attachments"
  ]
}

GET /recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}

Retrieves a single resume attachment instance for a \~prospect\~.

Retrieves the resume attachment with the specified ID for the specified \~prospect\~. Secured By Domain: Candidate Data: Attachments Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "prospects"
  ],
  "summary": "Retrieves a single resume attachment instance for a \\~prospect\\~.",
  "description": "Retrieves the resume attachment with the specified ID for the specified \\~prospect\\~.\n\n<b>Secured By Domain:</b> Candidate Data: Attachments\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/resumeAttachmentDetailsView_134c3544d220100007f0f9b541a400a5"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nThe file size should not exceed [file size]MB.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b627485bd061100019eefb6f66010180",
  "x-workday-secured-by-domains": [
    "Candidate Data: Attachments"
  ]
}

GET /recruiting/v4/jobPostings

Retrieves a collection of job postings.

Retrieves all job postings. You can filter by categories and job sites. Secured By Domain: Job Postings: External Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobPostings"
  ],
  "summary": "Retrieves a collection of job postings.",
  "description": "Retrieves all job postings. You can filter by categories and job sites.\n\n<b>Secured By Domain:</b> Job Postings: External\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "category",
      "in": "query",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "jobPosting",
      "in": "query",
      "description": "Job Posting for Job Posting Anchor",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "jobRequisition",
      "in": "query",
      "description": "Job Requisition for Job Posting Anchor",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "jobSite",
      "in": "query",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/jobPostingAnchorSummary_5597c990f22e10000fc34f022dce0020"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "5597c990f22e10000fc4975e37560022",
  "x-workday-secured-by-domains": [
    "Job Postings: External"
  ]
}

GET /recruiting/v4/jobPostings/{ID}/questionnaire

Retrieves a single questionnaire instance.

Retrieves a collection of questionnaires. Secured By Domain: Job Postings: External Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobPostings"
  ],
  "summary": "Retrieves a single questionnaire instance.",
  "description": "Retrieves a collection of questionnaires.\n\n<b>Secured By Domain:</b> Job Postings: External\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "questionnaireType",
      "in": "query",
      "description": "questionnaireType",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/questionnaireDetails_58cd464577ad1000ee76d171eea90000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "58cd464577ad1000f05fad5aa8270000",
  "x-workday-secured-by-domains": [
    "Job Postings: External"
  ]
}

GET /recruiting/v4/jobPostings/{ID}/questionnaire/{subresourceID}

Retrieves a single questionnaire for the specified job posting ID.

Retrieves all questionnaires for the specified job posting ID. Secured By Domain: Job Postings: External Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobPostings"
  ],
  "summary": "Retrieves a single questionnaire for the specified job posting ID.",
  "description": "Retrieves all questionnaires for the specified job posting ID.\n\n<b>Secured By Domain:</b> Job Postings: External\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/questionnaireDetails_58cd464577ad1000ee76d171eea90000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "58cd464577ad1000f05fad5aa8270000",
  "x-workday-secured-by-domains": [
    "Job Postings: External"
  ]
}

GET /recruiting/v4/jobPostings/{ID}/candidateAvailabilityTemplate/{subresourceID}

Retrieves a single instance of the candidate availability template version.

Returns the candidate availability template version for the active job posting for the specified ID. Secured By Domain: Job Postings: External Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobPostings"
  ],
  "summary": "Retrieves a single instance of the candidate availability template version.",
  "description": "Returns the candidate availability template version for the active job posting for the specified ID.\n\n<b>Secured By Domain:</b> Job Postings: External\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/availabilityTemplateDetails_617853847093100014ba0b710cd30000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "6178538470931000145391d429b70000",
  "x-workday-secured-by-domains": [
    "Job Postings: External"
  ]
}

GET /recruiting/v4/jobPostings/{ID}

Retrieves a job posting.

Retrieves a job posting with the specified ID Secured By Domain: Job Postings: External Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobPostings"
  ],
  "summary": "Retrieves a job posting.",
  "description": "Retrieves a job posting with the specified ID\n\n<b>Secured By Domain:</b> Job Postings: External\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/jobPostingAnchorSummary_5597c990f22e10000fc34f022dce0020"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "5597c990f22e10000fc4975e37560022",
  "x-workday-secured-by-domains": [
    "Job Postings: External"
  ]
}

GET /recruiting/v4/jobPostings/{ID}/candidateAvailabilityTemplate

Retrieves a single instance of the candidate availability template version.

Returns the candidate availability template version for the active job posting for the specified ID. Secured By Domain: Job Postings: External Scope: Recruiting

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobPostings"
  ],
  "summary": "Retrieves a single instance of the candidate availability template version.",
  "description": "Returns the candidate availability template version for the active job posting for the specified ID.\n\n<b>Secured By Domain:</b> Job Postings: External\n\n<b>Scope:</b> Recruiting",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/availabilityTemplateDetails_617853847093100014ba0b710cd30000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "6178538470931000145391d429b70000",
  "x-workday-secured-by-domains": [
    "Job Postings: External"
  ]
}

GET /recruiting/v4/values/common/countries/

Retrieves instances that can be used as values for other endpoint parameters in this service.

Authentication

[
  {
    "OAuth2": []
  }
]

Path-level parameters and metadata

{
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default and maximum is 1000.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "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.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "search",
      "in": "query",
      "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
      "schema": {
        "type": "string"
      }
    }
  ]
}

Request, responses and operation details

{
  "tags": [
    "Prompt Values"
  ],
  "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.",
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-protected-usage-enabled": false,
  "x-workday-internal-try-enabled": "true"
}

Schemas and reusable components

schemas

INSTANCE_MODEL_REFERENCE

{
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance",
      "readOnly": true
    },
    "href": {
      "type": "string",
      "description": "A link to the instance",
      "readOnly": true
    }
  }
}

ERROR_MODEL_REFERENCE

{
  "required": [
    "error"
  ],
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "A description of the error"
    },
    "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"
    },
    "field": {
      "type": "string",
      "description": "The field related to the error"
    },
    "path": {
      "type": "string",
      "description": "The path of the field related to the error"
    },
    "severity": {
      "type": "string",
      "description": "Severity of the validation (e.g. Critical, Warning)."
    },
    "internalMessage": {
      "type": "string",
      "description": "Internal message providing additional context for the validation (e.g. representation content validation details)."
    }
  }
}

VALIDATION_ERROR_MODEL_REFERENCE

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

FACETS_MODEL_REFERENCE

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

MULTIPLE_INSTANCE_MODEL_REFERENCE

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

jobApplication_df78b8e577c91000201ea3e7d0f60101

{
  "description": "The job application for the Recruiting event. Requires that the user is an interviewer for the in-progress Interview event or has access  to the Candidate Data: Interview Feedback Results domain.",
  "allOf": [
    {
      "$ref": "#/components/schemas/jobApplicationPublic_b36c621f46fd10001cc501100a4e03c7"
    },
    {
      "type": "object"
    }
  ]
}

interviewers_eb7eaf97ea8110000fafd115cf8e00ec

{
  "allOf": [
    {
      "$ref": "#/components/schemas/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for \\~Worker\\~"
        }
      }
    }
  ]
}

interviewStatuses_782d6c28615f10000374ab73f1530174

{
  "allOf": [
    {
      "$ref": "#/components/schemas/interviewStatusRepresentation_782d6c28615f10000371c7f006740172"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Interview Status"
        }
      }
    }
  ]
}

workersPendingFeedback_af722229b5c3100018ad0c79a75801a0

{
  "allOf": [
    {
      "$ref": "#/components/schemas/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for \\~Worker\\~"
        }
      }
    }
  ]
}

jobRequisition_df78b8e577c9100015f051a74e0b00a2

{
  "description": "The job requisition the candidate applied to. Requires that the user is an interviewer for the in-progress Interview event or has access  to the Candidate Data: Interview Feedback Results domain.",
  "allOf": [
    {
      "$ref": "#/components/schemas/jobRequisitionPublic_df78b8e577c91000162ee14015b600a4"
    },
    {
      "type": "object"
    }
  ]
}

interviewEventWithJobApplicationJobRequisitionInterviewerDetails_def69f12d55410000f7ec8da36ae005a

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "jobApplication": {
          "$ref": "#/components/schemas/jobApplication_df78b8e577c91000201ea3e7d0f60101"
        },
        "interviewers": {
          "type": "array",
          "description": "All  \\~workers\\~ selected to interview the candidate for a given Interview event.",
          "items": {
            "$ref": "#/components/schemas/interviewers_eb7eaf97ea8110000fafd115cf8e00ec"
          },
          "x-workday-type": "Multi-instance"
        },
        "overallComment": {
          "type": "string",
          "description": "The Overall Comment XIP configuration formatted as text.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "overallRating": {
          "type": "string",
          "description": "The Overall Rating XIP configuration formatted as text.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "interviewStatuses": {
          "type": "array",
          "description": "\"All applicable interview statuses for an Interview event. Statuses can be: \n * AWAITING_ME - An in-progress Interview event is waiting for the logged-in user's feedback. \n * COMPLETED - An Interview event is complete.\n * FEEDBACK_COMPLETE - All interview feedback for this in-progress event was submitted, but the Interview event isn’t awaiting the Make Interview Decision step.\n * NOT_SCHEDULED - An interview hasn't been scheduled for an in-progress Interview event.\n * PENDING_FEEDBACK - An in-progress Interview event is waiting for interviewer feedback.\n * SCHEDULED - An interview is scheduled for an in-progress Interview event.\n * SUBMITTED_FEEDBACK - The logged-in user submitted feedback for an in-progress Interview event.\n * MAKE_INTERVIEW_DECISION - The make an interview decision step for the candidate.\"",
          "items": {
            "$ref": "#/components/schemas/interviewStatuses_782d6c28615f10000374ab73f1530174"
          },
          "x-workday-type": "Multi-instance"
        },
        "hasCompetenciesQuestionnaires": {
          "type": "boolean",
          "description": "If true, the interviewer feedback task awaiting processing has Competencies or Questionnaires with configured XIP settings.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "workersPendingFeedback": {
          "type": "array",
          "description": "Interviewers with pending interview feedback.",
          "items": {
            "$ref": "#/components/schemas/workersPendingFeedback_af722229b5c3100018ad0c79a75801a0"
          },
          "x-workday-type": "Multi-instance"
        },
        "jobRequisition": {
          "$ref": "#/components/schemas/jobRequisition_df78b8e577c9100015f051a74e0b00a2"
        },
        "giveInterviewFeedbackLink": {
          "type": "string",
          "description": "A URL for the Give Interview Feedback task, for \\~workers\\~ with access to the Interview Feedback Detail event awaiting processing.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

overallRating_def69f12d5541000141441c84bd00096

{
  "description": "The interviewer's rating.",
  "allOf": [
    {
      "$ref": "#/components/schemas/interviewFeedbackRatingSummary_def69f12d554100013fe5747ffa50092"
    },
    {
      "type": "object"
    }
  ]
}

interviewDetailSummary_def69f12d5541000139a7815aae9008f

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "overallRating": {
          "$ref": "#/components/schemas/overallRating_def69f12d5541000141441c84bd00096"
        },
        "comment": {
          "type": "string",
          "description": "The interviewer's overall and competency comments.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "dateSubmitted": {
          "type": "string",
          "description": "The feedback submission date.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

status_4e798b9f4f0c10000f0d81a848650021

{
  "description": "The status of the \\~prospect\\~. See configured types in the Maintain \\~Prospect\\~ Statuses task.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

source_4e798b9f4f0c10000f0d818b76f6001f

{
  "description": "The source for the \\~prospect\\~. Examples: LinkedIn, Facebook.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

type_4e798b9f4f0c10000f0d819e58340020

{
  "description": "The type of the \\~prospect\\~. See configured types in the Maintain \\~Prospect\\~ Types task.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

referredBy_4e798b9f4f0c10000f0d81ba535a0023

{
  "description": "The \\~worker\\~ who referred the candidate.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

level_4e798b9f4f0c10000f0d81b1a0740022

{
  "description": "The targeted management level for the \\~Prospect\\~.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

candidatePools_7c49be35aa7210000fc8ff87959512bc

{
  "allOf": [
    {
      "$ref": "#/components/schemas/candidatePool_7c49be35aa7210001012f723bc6012ca"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Pool"
        }
      }
    }
  ]
}

candidateTags_7b4e2f108d3b10001639543785fe0039

{
  "allOf": [
    {
      "$ref": "#/components/schemas/candidateTag_7b4e2f108d3b1000162f47403b7d0037"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Tag"
        }
      }
    }
  ]
}

candidate_263b3523259410001ed40f0f6518126a

{
  "description": "The candidate profile associated with this \\~Prospect\\~.",
  "allOf": [
    {
      "$ref": "#/components/schemas/candidateSummary_263b3523259410001f3119d56cda126c"
    },
    {
      "type": "object"
    }
  ]
}

prospectSummary_7657284bd7781000178a3bf6e17f001a

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "status": {
          "$ref": "#/components/schemas/status_4e798b9f4f0c10000f0d81a848650021"
        },
        "contactConsent": {
          "type": "boolean",
          "description": "If true, the candidate agrees to be contacted.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "source": {
          "$ref": "#/components/schemas/source_4e798b9f4f0c10000f0d818b76f6001f"
        },
        "type": {
          "$ref": "#/components/schemas/type_4e798b9f4f0c10000f0d819e58340020"
        },
        "referredBy": {
          "$ref": "#/components/schemas/referredBy_4e798b9f4f0c10000f0d81ba535a0023"
        },
        "level": {
          "$ref": "#/components/schemas/level_4e798b9f4f0c10000f0d81b1a0740022"
        },
        "candidatePools": {
          "type": "array",
          "description": "The active, static pools for the candidate.",
          "items": {
            "$ref": "#/components/schemas/candidatePools_7c49be35aa7210000fc8ff87959512bc"
          },
          "x-workday-type": "Multi-instance"
        },
        "candidateTags": {
          "type": "array",
          "description": "The candidate tags associated with the candidate.",
          "items": {
            "$ref": "#/components/schemas/candidateTags_7b4e2f108d3b10001639543785fe0039"
          },
          "x-workday-type": "Multi-instance"
        },
        "candidate": {
          "$ref": "#/components/schemas/candidate_263b3523259410001ed40f0f6518126a"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

resumeAttachmentDetailsView_134c3544d220100007f0f9b541a400a5

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "fileName": {
          "maxLength": 255,
          "type": "string",
          "description": "The file name of the attachment.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "fileExtension": {
          "type": "string",
          "description": "The file extension of the attachment.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "fileLength": {
          "type": "integer",
          "description": "The file length of the attachment.",
          "format": "int32",
          "example": 99999999999,
          "x-workday-type": "Numeric"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

prospectExperienceDetails_b4dba3cbddc710001bebf80c43270014

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "Any responsibilities or accomplishments that the candidate gained at the associated company.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "location": {
          "type": "string",
          "description": "The location of this company.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "currentlyWorkHere": {
          "type": "boolean",
          "description": "If true, the candidate currently works at this company.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "startYear": {
          "type": "string",
          "description": "The year the candidate started employment at this company.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "startMonth": {
          "type": "integer",
          "description": "The month the candidate started employment at this company.",
          "format": "int32",
          "example": 99,
          "x-workday-type": "Numeric"
        },
        "title": {
          "type": "string",
          "description": "The business title for the candidate's work experience.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "endMonth": {
          "type": "integer",
          "description": "The month the candidate ended employment at this company.",
          "format": "int32",
          "example": 99,
          "x-workday-type": "Numeric"
        },
        "endYear": {
          "type": "string",
          "description": "The year the candidate ended employment at this company.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "companyName": {
          "type": "string",
          "description": "The company name the candidate entered in their job history.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

degree_9727f970aa23100005e6ec6727ee0011

{
  "description": "The candidate's degree at this educational institution.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

fieldOfStudy_9727f970aa23100005e6ec5e7dd10010

{
  "description": "The field of study for the candidate at this educational institution.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

candidateEducationDetails_9727f970aa231000052ae7db3fc0000b

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "gradeAverage": {
          "type": "string",
          "description": "The candidate's grade average at this educational institution.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "degree": {
          "$ref": "#/components/schemas/degree_9727f970aa23100005e6ec6727ee0011"
        },
        "schoolName": {
          "type": "string",
          "description": "The name of the school the candidate attended or is attending.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "fieldOfStudy": {
          "$ref": "#/components/schemas/fieldOfStudy_9727f970aa23100005e6ec5e7dd10010"
        },
        "firstYearAttended": {
          "type": "string",
          "description": "The first year the candidate attended this educational institution.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "lastYearAttended": {
          "type": "string",
          "description": "The last year the candidate attended this educational institution.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

candidateSkillItemDetails_2705750e957f10002beca80792940019

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the candidate skill.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

language_ecf7ccfb11c11000285d4771a6300019

{
  "description": "The language for this language skill.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

abilities_320147168979100014698d5722110045

{
  "allOf": [
    {
      "$ref": "#/components/schemas/languageAbilityDetails_ecf7ccfb11c110002a0cd3b3ff8b0022"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Language Ability Representation"
        }
      }
    }
  ]
}

candidateLanguageSkillDetails_ecf7ccfb11c11000285d4727e4270017

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "language": {
          "$ref": "#/components/schemas/language_ecf7ccfb11c11000285d4771a6300019"
        },
        "abilities": {
          "type": "array",
          "description": "The abilities associated with this language skill.",
          "items": {
            "$ref": "#/components/schemas/abilities_320147168979100014698d5722110045"
          },
          "x-workday-type": "Multi-instance"
        },
        "native": {
          "type": "boolean",
          "description": "If true, this language skill is the native language.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

categories_8b241418d7ce1000073b510f7c9a003f

{
  "allOf": [
    {
      "$ref": "#/components/schemas/jobFamilyGroupDetail_8b241418d7ce1000081068ca51810055"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Job Family"
        }
      }
    }
  ]
}

jobSite_8b241418d7ce1000073b5115cd300040

{
  "description": "The job posting site that the job is posted on.",
  "allOf": [
    {
      "$ref": "#/components/schemas/jobPostingSiteDetail_8b241418d7ce10000818455b78e40057"
    },
    {
      "type": "object"
    }
  ]
}

primaryLocation_8b241418d7ce1000073b51293ed40043

{
  "description": "The primary location for the job posting, according to the associated job requisition.",
  "allOf": [
    {
      "$ref": "#/components/schemas/locationSummary_8b241418d7ce100007a5c9eea7de004c"
    },
    {
      "type": "object"
    }
  ]
}

timeType_8b241418d7ce1000073b510155b0003d

{
  "description": "The position time type for job posting.",
  "allOf": [
    {
      "$ref": "#/components/schemas/positionTimeTypeDetail_8b241418d7ce100007fe51d00f630053"
    },
    {
      "type": "object"
    }
  ]
}

jobType_8b241418d7ce1000073b511c6e2a0041

{
  "description": "The \\~worker\\~ sub-type for the job posting, according to the job requisition.",
  "allOf": [
    {
      "$ref": "#/components/schemas/positionWorkerTypeDetail_8b241418d7ce1000089e70503c92005a"
    },
    {
      "type": "object"
    }
  ]
}

candidateAvailabilityTemplateVersion_e60aa0457a21100011bb304dbba40000

{
  "description": "Candidate Availability Template Version for Job Posting",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

additionalLocations_8b241418d7ce1000073b50f95caf003c

{
  "allOf": [
    {
      "$ref": "#/components/schemas/locationSummary_8b241418d7ce100007a5c9eea7de004c"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Location"
        }
      }
    }
  ]
}

company_8b241418d7ce1000073b5122b5a90042

{
  "description": "The \\~supervisory organization\\~ assigned to the job requisition associated with the job posting.",
  "allOf": [
    {
      "$ref": "#/components/schemas/organizationDetail_8b241418d7ce100008b027833f33005d"
    },
    {
      "type": "object"
    }
  ]
}

remoteType_d0be7f99be971000125025ffa1c40000

{
  "description": "The Job Requisition Remote Type for a Job Posting. For Remote Types with an External Name, the given external name is returned.",
  "allOf": [
    {
      "$ref": "#/components/schemas/remoteTypeDefinition_8bdd07e7084f1000151e15ccc3dd0000"
    },
    {
      "type": "object"
    }
  ]
}

jobPostingAnchorSummary_5597c990f22e10000fc34f022dce0020

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "categories": {
          "type": "array",
          "description": "The job family group for the job posting, according to the job requisition.",
          "items": {
            "$ref": "#/components/schemas/categories_8b241418d7ce1000073b510f7c9a003f"
          },
          "x-workday-type": "Multi-instance"
        },
        "jobSite": {
          "$ref": "#/components/schemas/jobSite_8b241418d7ce1000073b5115cd300040"
        },
        "jobDescription": {
          "type": "string",
          "description": "The description of the job for the job posting.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Rich Text"
        },
        "primaryLocation": {
          "$ref": "#/components/schemas/primaryLocation_8b241418d7ce1000073b51293ed40043"
        },
        "timeType": {
          "$ref": "#/components/schemas/timeType_8b241418d7ce1000073b510155b0003d"
        },
        "jobType": {
          "$ref": "#/components/schemas/jobType_8b241418d7ce1000073b511c6e2a0041"
        },
        "candidateAvailabilityTemplateVersion": {
          "$ref": "#/components/schemas/candidateAvailabilityTemplateVersion_e60aa0457a21100011bb304dbba40000"
        },
        "spotlightJob": {
          "type": "boolean",
          "description": "True if the job posting is a \\~Spotlight Job\\~ or not.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "additionalLocations": {
          "type": "array",
          "description": "The additional locations on the job posting, according to the job requisition.",
          "items": {
            "$ref": "#/components/schemas/additionalLocations_8b241418d7ce1000073b50f95caf003c"
          },
          "x-workday-type": "Multi-instance"
        },
        "company": {
          "$ref": "#/components/schemas/company_8b241418d7ce1000073b5122b5a90042"
        },
        "remoteType": {
          "$ref": "#/components/schemas/remoteType_d0be7f99be971000125025ffa1c40000"
        },
        "endDate": {
          "type": "string",
          "description": "The end date for the job posting.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "url": {
          "type": "string",
          "description": "External URL for Job Posting if it is posted to a published Workday External Career Site.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "startDate": {
          "type": "string",
          "description": "The start date for the job posting.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "title": {
          "type": "string",
          "description": "The title of the job posting, according to the associated job requisition.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

questions_35124aec314610000eeda239777500f3

{
  "allOf": [
    {
      "$ref": "#/components/schemas/questionItemDetails_35124aec314610000f15a3222d1800f9"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Question Item"
        }
      }
    }
  ]
}

questionnaireDetails_58cd464577ad1000ee76d171eea90000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "questions": {
          "type": "array",
          "description": "Returns all Parent-Level Question Items for the questionnaire",
          "items": {
            "$ref": "#/components/schemas/questions_35124aec314610000eeda239777500f3"
          },
          "x-workday-type": "Multi-instance"
        },
        "name": {
          "type": "string",
          "description": "The name of the questionnaire.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "questionnaireDisplayName": {
          "type": "string",
          "description": "The display name for the questionnaire.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text",
          "x-workday-confidence-level": "Production"
        },
        "referenceIdValue": {
          "type": "string",
          "description": "The reference ID for the Questionnaire",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "questionnaireInstructions": {
          "type": "string",
          "description": "Returns instructions for the questionnaire. These instructions may be overridden where the questionnaire is being used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Rich Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

mondayAvailability_deb14270132f10001fed2e410c850000

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

tuesdayAvailability_6d359e79836910003741d96fc0480005

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

sundayAvailability_6d359e79836910003741d96fc0480000

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

wednesdayAvailability_6d359e79836910003741d96fc0480004

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

thursdayAvailability_6d359e79836910003741d96fc0480003

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

saturdayAvailability_6d359e79836910003741d96fc0480001

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

fridayAvailability_6d359e79836910003741d96fc0480002

{
  "allOf": [
    {
      "$ref": "#/components/schemas/timeslot_2e016acbd91810000809d655a1fc0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Candidate Availability Time Slot"
        }
      }
    }
  ]
}

availabilityTemplateDetails_617853847093100014ba0b710cd30000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "mondayAvailability": {
          "type": "array",
          "description": "Monday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/mondayAvailability_deb14270132f10001fed2e410c850000"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Monday Time Slots"
        },
        "tuesdayAvailability": {
          "type": "array",
          "description": "Tuesday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/tuesdayAvailability_6d359e79836910003741d96fc0480005"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Tuesday Time Slots"
        },
        "sundayAvailability": {
          "type": "array",
          "description": "Sunday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/sundayAvailability_6d359e79836910003741d96fc0480000"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Sunday Time Slots"
        },
        "templateName": {
          "type": "string",
          "description": "Name of the template version.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text",
          "x-label": "Availability Template Name"
        },
        "wednesdayAvailability": {
          "type": "array",
          "description": "Wednesday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/wednesdayAvailability_6d359e79836910003741d96fc0480004"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Wednesday Time Slots"
        },
        "thursdayAvailability": {
          "type": "array",
          "description": "Thursday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/thursdayAvailability_6d359e79836910003741d96fc0480003"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Thursday Time Slots"
        },
        "saturdayAvailability": {
          "type": "array",
          "description": "Saturday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/saturdayAvailability_6d359e79836910003741d96fc0480001"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Saturday Time Slots"
        },
        "fridayAvailability": {
          "type": "array",
          "description": "Friday timeslots for template version.",
          "items": {
            "$ref": "#/components/schemas/fridayAvailability_6d359e79836910003741d96fc0480002"
          },
          "x-workday-type": "Multi-instance",
          "x-label": "Friday Time Slots"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

possibleAnswers_35124aec314610000f15a340986c00fe

{
  "allOf": [
    {
      "$ref": "#/components/schemas/questionMultipleChoiceAnswerDetails_35124aec314610000f355986c6490104"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Question Score"
        }
      }
    }
  ]
}

type_35124aec314610000f15a34518bf00ff

{
  "description": "The type of the question.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

displayOption_35124aec314610000f15a32daa6600fa

{
  "description": "Returns the display option selected for the question. Answer choices will be presented this way to users answering the question.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

questionItemDetails_35124aec314610000f15a3222d1800f9

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "numberOfSelections": {
          "type": "integer",
          "description": "The number of allowed answers for a question for a questionnaire",
          "format": "int32",
          "example": 99,
          "x-workday-type": "Numeric"
        },
        "order": {
          "type": "string",
          "description": "The order of the question within the questionnaire.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "possibleAnswers": {
          "type": "array",
          "description": "Returns the scores for the multiple choice answers configured for the multiple choice question.",
          "items": {
            "$ref": "#/components/schemas/possibleAnswers_35124aec314610000f15a340986c00fe"
          },
          "x-workday-type": "Multi-instance"
        },
        "required": {
          "type": "boolean",
          "description": "Indicator whether the answer for the question is required.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "type": {
          "$ref": "#/components/schemas/type_35124aec314610000f15a34518bf00ff"
        },
        "displayOption": {
          "$ref": "#/components/schemas/displayOption_35124aec314610000f15a32daa6600fa"
        },
        "body": {
          "type": "string",
          "description": "The body of the question.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "The id for Question Item"
        }
      }
    }
  ]
}

social_a229cf3cded91000151b47c7e0e2012c

{
  "description": "The social suffix from the name.",
  "allOf": [
    {
      "$ref": "#/components/schemas/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d"
    },
    {
      "type": "object"
    }
  ],
  "x-workday-populated-by": {
    "path": "/values/name/social",
    "field": "id"
  }
}

salutation_a229cf3cded91000151b47b82570012a

{
  "description": "The salutation from the name.",
  "allOf": [
    {
      "$ref": "#/components/schemas/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d"
    },
    {
      "type": "object"
    }
  ],
  "x-workday-populated-by": {
    "path": "/values/name/salutation",
    "field": "id"
  }
}

country_a229cf3cded91000151b47775e040123

{
  "description": "The country from the name.",
  "allOf": [
    {
      "$ref": "#/components/schemas/country_1089da0ab90910000f6d7bd30bb20881"
    },
    {
      "type": "object"
    }
  ]
}

hereditary_a229cf3cded91000151b479726220126

{
  "description": "The hereditary suffix from the name.",
  "allOf": [
    {
      "$ref": "#/components/schemas/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d"
    },
    {
      "type": "object"
    }
  ],
  "x-workday-populated-by": {
    "path": "/values/name/hereditary",
    "field": "id"
  }
}

title_a229cf3cded91000151b47af4c400129

{
  "description": "The prefix from the name.",
  "allOf": [
    {
      "$ref": "#/components/schemas/countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d"
    },
    {
      "type": "object"
    }
  ],
  "x-workday-populated-by": {
    "path": "/values/name/title",
    "field": "id"
  }
}

name_59514ca580dc100021a2a27ee1880689

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "secondaryLocal": {
          "type": "string",
          "description": "The person's secondary family name in local script.  Workday only tracks local names for countries where a non-Latin script is commonly used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "firstNameLocal": {
          "type": "string",
          "description": "The person's given name in local script.  Workday only tracks local names for countries where a non-Latin script is commonly used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "firstNameLocal2": {
          "type": "string",
          "description": "The person's given name in second local script.  Workday only tracks local names for countries where a non-Latin script is commonly used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "social": {
          "$ref": "#/components/schemas/social_a229cf3cded91000151b47c7e0e2012c"
        },
        "salutation": {
          "$ref": "#/components/schemas/salutation_a229cf3cded91000151b47b82570012a"
        },
        "fullName": {
          "type": "string",
          "description": "The Full Name for a person, when it is provided. Workday only tracks Full Name for countries where the Full Name name component is used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "lastNameLocal2": {
          "type": "string",
          "description": "The person's last name in second local script.  Workday only tracks local names for countries where a non-Latin script is commonly used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "lastName": {
          "type": "string",
          "description": "The last or family name for a person.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "secondaryLastName": {
          "type": "string",
          "description": "The secondary family name for a person.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "middleNameLocal": {
          "type": "string",
          "description": "The person's middle name in local script.  Workday only tracks local names for countries where a non-Latin script is commonly used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "country": {
          "$ref": "#/components/schemas/country_a229cf3cded91000151b47775e040123"
        },
        "firstName": {
          "type": "string",
          "description": "The first or given name for a person.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "lastNameLocal": {
          "type": "string",
          "description": "The person's last name in local script.  Workday only tracks local names for countries where a non-Latin script is commonly used.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "middleName": {
          "type": "string",
          "description": "The person's middle name.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "tertiaryLastName": {
          "type": "string",
          "description": "The person's tertiary last name.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "hereditary": {
          "$ref": "#/components/schemas/hereditary_a229cf3cded91000151b479726220126"
        },
        "title": {
          "$ref": "#/components/schemas/title_a229cf3cded91000151b47af4c400129"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Global Name Interface (Derived)"
        }
      }
    }
  ]
}

jobApplicationPublic_b36c621f46fd10001cc501100a4e03c7

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "numberOfJobs": {
          "type": "integer",
          "description": "The number of jobs for a candidate on this job application.",
          "format": "int32",
          "example": 999999,
          "x-workday-type": "Numeric"
        },
        "yearsInCurrentJob": {
          "type": "number",
          "description": "The number of years the candidate has been employed at their current job",
          "format": "double",
          "example": 99999999999.999,
          "x-workday-type": "Numeric"
        },
        "totalYearsExperience": {
          "type": "number",
          "description": "The total years of experience for the candidate on this job application.",
          "format": "double",
          "example": 99999999999.999,
          "x-workday-type": "Numeric"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Job Application  \nExample(s): Job_Application_ID=Sample_Value"
        }
      }
    }
  ]
}

candidatePool_7c49be35aa7210001012f723bc6012ca

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

contentType_ee22ee09075410000346b6722d9b03e8

{
  "description": "The content type of the attachment.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

resumeAttachmentDetailsCreate_ee22ee09075410000346b5ebfa2303e4

{
  "allOf": [
    {
      "required": [
        "attachmentContent",
        "fileLength"
      ],
      "type": "object",
      "properties": {
        "attachmentContent": {
          "type": "string",
          "description": "The raw base64 data for an attachment or image for reports used as web services (RaaS) only.",
          "format": "binary",
          "x-workday-type": "File"
        },
        "fileName": {
          "maxLength": 255,
          "type": "string",
          "description": "The file name of the attachment.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "fileLength": {
          "type": "integer",
          "description": "The file length of the attachment.",
          "format": "int32",
          "example": 99999999999,
          "x-workday-type": "Numeric"
        },
        "contentType": {
          "$ref": "#/components/schemas/contentType_ee22ee09075410000346b6722d9b03e8"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

region_8b241418d7ce100007a5ca0b072e004e

{
  "description": "Returns the country region for the location.",
  "allOf": [
    {
      "$ref": "#/components/schemas/countryRegionDetail_8b241418d7ce100007a4d8749d270049"
    },
    {
      "type": "object"
    }
  ]
}

country_8b241418d7ce100007a5ca00337b004d

{
  "description": "Returns the \\~country\\~ from the primary address for the location.",
  "allOf": [
    {
      "$ref": "#/components/schemas/countryDetail_8b241418d7ce10000797fe76c17a0046"
    },
    {
      "type": "object"
    }
  ]
}

locationSummary_8b241418d7ce100007a5c9eea7de004c

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "region": {
          "$ref": "#/components/schemas/region_8b241418d7ce100007a5ca0b072e004e"
        },
        "country": {
          "$ref": "#/components/schemas/country_8b241418d7ce100007a5ca00337b004d"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Location"
        }
      }
    }
  ]
}

interviewStatusRepresentation_782d6c28615f10000371c7f006740172

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

jobFamilyGroupDetail_8b241418d7ce1000081068ca51810055

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

recruiters_3b057822a75f100009d3dfe5672a0027

{
  "allOf": [
    {
      "$ref": "#/components/schemas/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for \\~Worker\\~"
        }
      }
    }
  ]
}

primaryRecruiters_7469d71c04f610001aa86e35418d0010

{
  "allOf": [
    {
      "$ref": "#/components/schemas/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for \\~Worker\\~"
        }
      }
    }
  ]
}

hiringManager_b47f16fb63e910000a6ac5854fd4021c

{
  "description": "The hiring manager for a job requisition.",
  "allOf": [
    {
      "$ref": "#/components/schemas/workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016"
    },
    {
      "type": "object"
    }
  ]
}

jobRequisitionPublic_df78b8e577c91000162ee14015b600a4

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "recruiters": {
          "type": "array",
          "description": "The non-primary recruiters assigned to the job requisition.",
          "items": {
            "$ref": "#/components/schemas/recruiters_3b057822a75f100009d3dfe5672a0027"
          },
          "x-workday-type": "Multi-instance"
        },
        "primaryRecruiters": {
          "type": "array",
          "description": "The primary recruiters assigned to the job requisition. If no primary recruiter is assigned, the field is blank.",
          "items": {
            "$ref": "#/components/schemas/primaryRecruiters_7469d71c04f610001aa86e35418d0010"
          },
          "x-workday-type": "Multi-instance"
        },
        "hiringManager": {
          "$ref": "#/components/schemas/hiringManager_b47f16fb63e910000a6ac5854fd4021c"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

timeslot_2e016acbd91810000809d655a1fc0000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

branchingQuestion_b846d79e92ac100013f9842aa5700161

{
  "description": "Branching Question Item for Question Score",
  "allOf": [
    {
      "$ref": "#/components/schemas/questionItemDetails_35124aec314610000f15a3222d1800f9"
    },
    {
      "type": "object"
    }
  ]
}

questionMultipleChoiceAnswerDetails_35124aec314610000f355986c6490104

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "score": {
          "type": "integer",
          "description": "Returns the score for the multiple choice answer configured for the multiple choice question.",
          "format": "int32",
          "example": 99999999999,
          "x-workday-type": "Numeric"
        },
        "descriptor": {
          "type": "string",
          "description": "The answer text for the Question Multiple Choice Answer",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "order": {
          "type": "string",
          "description": "The order for the Question Multiple Choice Answer",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "branchingQuestion": {
          "$ref": "#/components/schemas/branchingQuestion_b846d79e92ac100013f9842aa5700161"
        },
        "id": {
          "type": "string",
          "description": "The Workday ID for the Question Multiple Choice Answer",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        }
      }
    }
  ]
}

countryPredefinedNameComponent_e16f06ca954910001a110a8851cd013d

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

positionTimeTypeDetail_8b241418d7ce100007fe51d00f630053

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

deviceType_6f9c0428295210002484a8f3720f1796

{
  "description": "The type of phone device.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

countryPhoneCode_6f9c04282952100023a80fd30a5f173e

{
  "description": "The \\~country\\~ code of the phone number.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

candidatePhoneDetails_6f9c04282952100023a80fa49bde173d

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "deviceType": {
          "$ref": "#/components/schemas/deviceType_6f9c0428295210002484a8f3720f1796"
        },
        "phoneNumber": {
          "type": "string",
          "description": "The full primary phone number of the person.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "extension": {
          "type": "string",
          "description": "The phone number extension.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "countryPhoneCode": {
          "$ref": "#/components/schemas/countryPhoneCode_6f9c04282952100023a80fd30a5f173e"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Phone Interface (Derived)"
        }
      }
    }
  ]
}

workerForInterviewRepresentation_0e1101ea4ec4100008fdfd8289ed0016

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

remoteTypeDefinition_8bdd07e7084f1000151e15ccc3dd0000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The external or internal name of the Job Requisition Remote Type for the given Job Posting.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

countryDetail_8b241418d7ce10000797fe76c17a0046

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "alpha3Code": {
          "maxLength": 3,
          "type": "string",
          "description": "The ISO alpha-3 code for a country.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        }
      }
    }
  ]
}

proficiency_ecf7ccfb11c110002a0cd3c79f4c0023

{
  "description": "The proficiency for a specific language ability.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

abilityType_ecf7ccfb11c110002a0cd3d48d1d0024

{
  "description": "The type of language ability. See the configured types in the Maintain Language Ability Types.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

languageAbilityDetails_ecf7ccfb11c110002a0cd3b3ff8b0022

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "proficiency": {
          "$ref": "#/components/schemas/proficiency_ecf7ccfb11c110002a0cd3c79f4c0023"
        },
        "abilityType": {
          "$ref": "#/components/schemas/abilityType_ecf7ccfb11c110002a0cd3d48d1d0024"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

organizationDetail_8b241418d7ce100008b027833f33005d

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

phone_4d9dacbbb7bb10000c97867b421a4c7e

{
  "description": "The candidate's primary home phone number.",
  "allOf": [
    {
      "$ref": "#/components/schemas/candidatePhoneDetails_6f9c04282952100023a80fa49bde173d"
    },
    {
      "type": "object"
    }
  ]
}

name_59514ca580dc100021a481f97c54068b

{
  "description": "The global name associated with the candidate.",
  "allOf": [
    {
      "$ref": "#/components/schemas/name_59514ca580dc100021a2a27ee1880689"
    },
    {
      "type": "object"
    }
  ]
}

candidateSummary_263b3523259410001f3119d56cda126c

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "phone": {
          "$ref": "#/components/schemas/phone_4d9dacbbb7bb10000c97867b421a4c7e"
        },
        "name": {
          "$ref": "#/components/schemas/name_59514ca580dc100021a481f97c54068b"
        },
        "email": {
          "type": "string",
          "description": "The candidate's email address.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Candidate"
        }
      }
    }
  ]
}

positionWorkerTypeDetail_8b241418d7ce1000089e70503c92005a

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

interviewFeedbackRatingSummary_def69f12d554100013fe5747ffa50092

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

countryRegionDetail_8b241418d7ce100007a4d8749d270049

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The region-only portion of the ISO 3166-2 code for a country region.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        }
      }
    }
  ]
}

candidateTag_7b4e2f108d3b1000162f47403b7d0037

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

country_1089da0ab90910000f6d7bd30bb20881

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

resumeAttachmentFileView_ee7318fbf39e10001e321c67d42300c0

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "attachmentContent": {
          "type": "string",
          "description": "The raw base64 data for an attachment or image for reports used as web services (RaaS) only.",
          "format": "binary",
          "x-workday-type": "File"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

jobPostingSiteDetail_8b241418d7ce10000818455b78e40057

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

securitySchemes

OAuth2

{
  "type": "oauth2",
  "flows": {
    "implicit": {
      "authorizationUrl": "https://<tenantAuthorizationHostname>",
      "scopes": {}
    }
  }
}

Path metadata and references

{
  "/recruiting/v4/values/common/countries/": {
    "parameters": [
      {
        "name": "limit",
        "in": "query",
        "description": "The maximum number of objects in a single response. The default and maximum is 1000.",
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      {
        "name": "offset",
        "in": "query",
        "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.",
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      {
        "name": "search",
        "in": "query",
        "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
        "schema": {
          "type": "string"
        }
      }
    ]
  }
}

Document metadata and extensions

{
  "openapi": "3.0.1",
  "info": {
    "title": "recruiting",
    "description": "The Recruiting service enables applications to access Workday data about recruiting, such as job postings, prospects, and interviews.",
    "version": "v4",
    "x-workday-confidence-level": "Production",
    "x-workday-internal-source": "xo",
    "x-workday-internal-routing": "Public",
    "x-workday-internal-protected-usage-enabled": false,
    "x-workday-internal-service-container-id": "ba74f44bc90e107329f6353919340036"
  },
  "tags": [
    {
      "name": "interviews"
    },
    {
      "name": "jobPostings",
      "description": "Provides the ability to retrieve job postings."
    },
    {
      "name": "prospects",
      "description": "Provides the ability to retrieve and create prospect data."
    },
    {
      "name": "Prompt Values",
      "description": "Retrieves instances that can be used as values for other endpoint parameters in this service."
    }
  ],
  "security": [
    {
      "OAuth2": []
    }
  ],
  "x-purple-suite-contract": "full-service-repository-modeled-runtime",
  "x-purple-suite-upstream-servers": [
    {
      "url": "https://<tenantHostname>/recruiting/v4"
    }
  ],
  "x-purple-suite-runtime-fidelity": {
    "capturedOperationIds": [],
    "modeledOperationIds": [
      "workdayRecruitingGetInterviews",
      "workdayRecruitingGetInterviewsByIDFeedback",
      "workdayRecruitingPostInterviewsByIDFeedback",
      "workdayRecruitingGetInterviewsByID",
      "workdayRecruitingGetInterviewsByIDFeedbackBySubresourceID",
      "workdayRecruitingPostProspects",
      "workdayRecruitingGetProspectsByIDEducationsBySubresourceID",
      "workdayRecruitingGetProspectsByIDLanguagesBySubresourceID",
      "workdayRecruitingGetProspectsByIDResumeAttachments",
      "workdayRecruitingPostProspectsByIDResumeAttachments",
      "workdayRecruitingGetProspectsByIDExperiences",
      "workdayRecruitingPostProspectsByIDExperiences",
      "workdayRecruitingGetProspectsByIDLanguages",
      "workdayRecruitingPostProspectsByIDLanguages",
      "workdayRecruitingGetProspectsByIDSkillsBySubresourceID",
      "workdayRecruitingGetProspectsByIDResumeAttachmentsTypeViewFile",
      "workdayRecruitingGetProspectsByIDSkills",
      "workdayRecruitingPostProspectsByIDSkills",
      "workdayRecruitingGetProspectsByIDExperiencesBySubresourceID",
      "workdayRecruitingGetProspectsByIDEducations",
      "workdayRecruitingPostProspectsByIDEducations",
      "workdayRecruitingGetProspectsByID",
      "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceIDTypeViewFile",
      "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceID",
      "workdayRecruitingGetJobPostings",
      "workdayRecruitingGetJobPostingsByIDQuestionnaire",
      "workdayRecruitingGetJobPostingsByIDQuestionnaireBySubresourceID",
      "workdayRecruitingGetJobPostingsByIDCandidateAvailabilityTemplateBySubresourceID",
      "workdayRecruitingGetJobPostingsByID",
      "workdayRecruitingGetJobPostingsByIDCandidateAvailabilityTemplate",
      "workdayRecruitingGetValuesCommonCountries"
    ],
    "operations": [
      {
        "operationId": "workdayRecruitingGetInterviews",
        "method": "get",
        "path": "/recruiting/v4/interviews",
        "upstreamPath": "/interviews",
        "fidelity": "modeled",
        "xWorkdayOperationId": "df78b8e577c910001f381909b55100e6"
      },
      {
        "operationId": "workdayRecruitingGetInterviewsByIDFeedback",
        "method": "get",
        "path": "/recruiting/v4/interviews/{ID}/feedback",
        "upstreamPath": "/interviews/{ID}/feedback",
        "fidelity": "modeled",
        "xWorkdayOperationId": "df78b8e577c910001ba2775bb2e200c8"
      },
      {
        "operationId": "workdayRecruitingPostInterviewsByIDFeedback",
        "method": "post",
        "path": "/recruiting/v4/interviews/{ID}/feedback",
        "upstreamPath": "/interviews/{ID}/feedback",
        "fidelity": "modeled",
        "xWorkdayOperationId": "df78b8e577c91000174144aa747100b1"
      },
      {
        "operationId": "workdayRecruitingGetInterviewsByID",
        "method": "get",
        "path": "/recruiting/v4/interviews/{ID}",
        "upstreamPath": "/interviews/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "df78b8e577c910001f381909b55100e6"
      },
      {
        "operationId": "workdayRecruitingGetInterviewsByIDFeedbackBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/interviews/{ID}/feedback/{subresourceID}",
        "upstreamPath": "/interviews/{ID}/feedback/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "df78b8e577c910001ba2775bb2e200c8"
      },
      {
        "operationId": "workdayRecruitingPostProspects",
        "method": "post",
        "path": "/recruiting/v4/prospects",
        "upstreamPath": "/prospects",
        "fidelity": "modeled",
        "xWorkdayOperationId": "50be5081f82e10000a3259d6e22d05b7"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDEducationsBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/educations/{subresourceID}",
        "upstreamPath": "/prospects/{ID}/educations/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "9727f970aa231000060528416b7b0016"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDLanguagesBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/languages/{subresourceID}",
        "upstreamPath": "/prospects/{ID}/languages/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "ecf7ccfb11c110002805608ea5d80015"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDResumeAttachments",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/resumeAttachments",
        "upstreamPath": "/prospects/{ID}/resumeAttachments",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b627485bd061100019eefb6f66010180"
      },
      {
        "operationId": "workdayRecruitingPostProspectsByIDResumeAttachments",
        "method": "post",
        "path": "/recruiting/v4/prospects/{ID}/resumeAttachments",
        "upstreamPath": "/prospects/{ID}/resumeAttachments",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b627485bd061100019eefbc59fe90182"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDExperiences",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/experiences",
        "upstreamPath": "/prospects/{ID}/experiences",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b4dba3cbddc710001bf375eb8400001c"
      },
      {
        "operationId": "workdayRecruitingPostProspectsByIDExperiences",
        "method": "post",
        "path": "/recruiting/v4/prospects/{ID}/experiences",
        "upstreamPath": "/prospects/{ID}/experiences",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b4dba3cbddc710001bf375af9e44001b"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDLanguages",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/languages",
        "upstreamPath": "/prospects/{ID}/languages",
        "fidelity": "modeled",
        "xWorkdayOperationId": "ecf7ccfb11c110002805608ea5d80015"
      },
      {
        "operationId": "workdayRecruitingPostProspectsByIDLanguages",
        "method": "post",
        "path": "/recruiting/v4/prospects/{ID}/languages",
        "upstreamPath": "/prospects/{ID}/languages",
        "fidelity": "modeled",
        "xWorkdayOperationId": "ecf7ccfb11c110002afc9babda82002e"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDSkillsBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/skills/{subresourceID}",
        "upstreamPath": "/prospects/{ID}/skills/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "d1f5b73501871000123b3f69018f005e"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDResumeAttachmentsTypeViewFile",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/resumeAttachments?type=viewFile",
        "upstreamPath": "/prospects/{ID}/resumeAttachments?type=viewFile",
        "fidelity": "modeled",
        "queryDiscriminator": {
          "parameter": "type",
          "value": "viewFile"
        },
        "xWorkdayOperationId": "b627485bd061100019eefbbb0d6c0181"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDSkills",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/skills",
        "upstreamPath": "/prospects/{ID}/skills",
        "fidelity": "modeled",
        "xWorkdayOperationId": "d1f5b73501871000123b3f69018f005e"
      },
      {
        "operationId": "workdayRecruitingPostProspectsByIDSkills",
        "method": "post",
        "path": "/recruiting/v4/prospects/{ID}/skills",
        "upstreamPath": "/prospects/{ID}/skills",
        "fidelity": "modeled",
        "xWorkdayOperationId": "2705750e957f10002bc3d403249c0017"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDExperiencesBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/experiences/{subresourceID}",
        "upstreamPath": "/prospects/{ID}/experiences/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b4dba3cbddc710001bf375eb8400001c"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDEducations",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/educations",
        "upstreamPath": "/prospects/{ID}/educations",
        "fidelity": "modeled",
        "xWorkdayOperationId": "9727f970aa231000060528416b7b0016"
      },
      {
        "operationId": "workdayRecruitingPostProspectsByIDEducations",
        "method": "post",
        "path": "/recruiting/v4/prospects/{ID}/educations",
        "upstreamPath": "/prospects/{ID}/educations",
        "fidelity": "modeled",
        "xWorkdayOperationId": "9727f970aa231000052be822d809000d"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByID",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}",
        "upstreamPath": "/prospects/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "ef3d700eb59610001e2f0dcf2ea90013"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceIDTypeViewFile",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}?type=viewFile",
        "upstreamPath": "/prospects/{ID}/resumeAttachments/{subresourceID}?type=viewFile",
        "fidelity": "modeled",
        "queryDiscriminator": {
          "parameter": "type",
          "value": "viewFile"
        },
        "xWorkdayOperationId": "b627485bd061100019eefbbb0d6c0181"
      },
      {
        "operationId": "workdayRecruitingGetProspectsByIDResumeAttachmentsBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}",
        "upstreamPath": "/prospects/{ID}/resumeAttachments/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b627485bd061100019eefb6f66010180"
      },
      {
        "operationId": "workdayRecruitingGetJobPostings",
        "method": "get",
        "path": "/recruiting/v4/jobPostings",
        "upstreamPath": "/jobPostings",
        "fidelity": "modeled",
        "xWorkdayOperationId": "5597c990f22e10000fc4975e37560022"
      },
      {
        "operationId": "workdayRecruitingGetJobPostingsByIDQuestionnaire",
        "method": "get",
        "path": "/recruiting/v4/jobPostings/{ID}/questionnaire",
        "upstreamPath": "/jobPostings/{ID}/questionnaire",
        "fidelity": "modeled",
        "xWorkdayOperationId": "58cd464577ad1000f05fad5aa8270000"
      },
      {
        "operationId": "workdayRecruitingGetJobPostingsByIDQuestionnaireBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/jobPostings/{ID}/questionnaire/{subresourceID}",
        "upstreamPath": "/jobPostings/{ID}/questionnaire/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "58cd464577ad1000f05fad5aa8270000"
      },
      {
        "operationId": "workdayRecruitingGetJobPostingsByIDCandidateAvailabilityTemplateBySubresourceID",
        "method": "get",
        "path": "/recruiting/v4/jobPostings/{ID}/candidateAvailabilityTemplate/{subresourceID}",
        "upstreamPath": "/jobPostings/{ID}/candidateAvailabilityTemplate/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "6178538470931000145391d429b70000"
      },
      {
        "operationId": "workdayRecruitingGetJobPostingsByID",
        "method": "get",
        "path": "/recruiting/v4/jobPostings/{ID}",
        "upstreamPath": "/jobPostings/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "5597c990f22e10000fc4975e37560022"
      },
      {
        "operationId": "workdayRecruitingGetJobPostingsByIDCandidateAvailabilityTemplate",
        "method": "get",
        "path": "/recruiting/v4/jobPostings/{ID}/candidateAvailabilityTemplate",
        "upstreamPath": "/jobPostings/{ID}/candidateAvailabilityTemplate",
        "fidelity": "modeled",
        "xWorkdayOperationId": "6178538470931000145391d429b70000"
      },
      {
        "operationId": "workdayRecruitingGetValuesCommonCountries",
        "method": "get",
        "path": "/recruiting/v4/values/common/countries/",
        "upstreamPath": "/values/common/countries/",
        "fidelity": "modeled"
      }
    ]
  },
  "x-purple-suite-runtime-path-canonicalization": [
    {
      "documentedPath": "/recruiting/v4/prospects/{ID}/resumeAttachments?type=viewFile",
      "runtimePath": "/recruiting/v4/prospects/:ID/resumeAttachments",
      "queryDiscriminator": {
        "parameter": "type",
        "value": "viewFile"
      },
      "reason": "The pinned Workday artifact encodes a query string in an OpenAPI path key; HTTP routing canonicalizes only this exact single-value discriminator."
    },
    {
      "documentedPath": "/recruiting/v4/prospects/{ID}/resumeAttachments/{subresourceID}?type=viewFile",
      "runtimePath": "/recruiting/v4/prospects/:ID/resumeAttachments/:subresourceID",
      "queryDiscriminator": {
        "parameter": "type",
        "value": "viewFile"
      },
      "reason": "The pinned Workday artifact encodes a query string in an OpenAPI path key; HTTP routing canonicalizes only this exact single-value discriminator."
    }
  ],
  "x-purple-suite-exclusions": [
    "Workday Web Services (SOAP/WWS)",
    "Workday Graph API",
    "Workday Query Language (WQL), a separate Platform API family",
    "Reports-as-a-Service (RaaS) and tenant custom reports",
    "Finance, Payroll, Student, and non-HR Platform REST services",
    "Experimental alpha, beta, and labs services",
    "Tenant-configured actions absent from the pinned public artifacts"
  ]
}