Workday Recruiting · JSON Structure

Recruiting Rest Api Recruiting Agency Structure

A recruiting agency represents an external staffing or recruitment firm that submits candidates for open positions.

Type: object Properties: 7
HCMHuman ResourcesRecruitingSaaSTalent Acquisition

RecruitingAgency is a JSON Structure definition published by Workday Recruiting, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name contactName contactEmail phone feePercentage active

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-recruiting/refs/heads/main/json-structure/recruiting-rest-api-recruiting-agency-structure.json",
  "name": "RecruitingAgency",
  "description": "A recruiting agency represents an external staffing or recruitment firm that submits candidates for open positions.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Workday ID (WID) of the recruiting agency",
      "example": "11111111-2222-3333-4444-555555555555"
    },
    "name": {
      "type": "string",
      "description": "Agency name",
      "example": "Senior Software Engineer"
    },
    "contactName": {
      "type": "string",
      "description": "Primary contact name",
      "example": "Senior Software Engineer"
    },
    "contactEmail": {
      "type": "string",
      "description": "Primary contact email",
      "example": "candidate@example.com"
    },
    "phone": {
      "type": "string",
      "description": "Agency phone number",
      "example": "+1-415-555-0123"
    },
    "feePercentage": {
      "type": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Agency fee as a percentage of first-year compensation",
      "example": 22.5
    },
    "active": {
      "type": "boolean",
      "description": "Whether the agency relationship is currently active",
      "example": true
    }
  }
}