copied!
{
  "type": "object",
  "properties": {
    "from": {
      "type": "integer",
      "description": "Starting point from which the data should be retrieved."
    },
    "size": {
      "type": "integer",
      "description": "Size of the response."
    },
    "searchkeyword": {
      "type": "string",
      "description": "Searching entered keyword in candidate profile."
    },
    "filters": {
      "type": "array",
      "description": "Apply one or multiple filters(String, Boolean, Date, or Enum) of below types to refine results.",
      "items": {
        "oneOf": [
          {
            "StringFilter": {
              "type": "object",
              "properties": {
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "String representing the values of field."
                  }
                },
                "operator": {
                  "type": "string",
                  "enum": [
                    "Is",
                    "Is not",
                    "Contains",
                    "Does not contain",
                    "Starts with",
                    "Ends with"
                  ],
                  "description": "Operator for filtering strings."
                },
                "field": {
                  "type": "string",
                  "enum": [
                    "firstName",
                    "currentCompany.jobTitle",
                    "skillList.value",
                    "trafficSourceList.sourceShortName",
                    "experience.jobLocation",
                    "experience.jobTitle",
                    "education.degree",
                    "highestEducation.degree",
                    "education.fieldOfStudy",
                    "preferredLocationList.location",
                    "newLocation.city",
                    "newLocation.country",
                    "emailList.email",
                    "languageKnown",
                    "lastName",
                    "newLocation.state",
                    "newLocation.zipCode"
                  ],
                  "description": "Name of the data attribute to be filtered with values."
                }
              },
              "required": [
                "values",
                "operator"
              ]
            }
          },
          {
            "BooleanFilter": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "boolean",
                  "description": "The boolean value to filter by."
                },
                "operator": {
                  "type": "string",
                  "enum": [
                    "True",
                    "False"
                  ],
                  "description": "Operator for filtering booleans."
                },
                "field": {
                  "type": "string",
                  "enum": [
                    "internal",
                    "jtcCandidates"
                  ],
                  "description": "Name of the data attribute to be filtered with values."
                }
              },
              "required": [
                "value",
                "operator"
              ]
            }
          },
          {
            "DateFilter": {
              "type": "object",
              "properties": {
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "date",
                    "description": "String representing the values of date filter."
                  }
                },
                "operator": {
                  "type": "string",
                  "enum": [
                    "Equal to",
                    "Not equal to",
                    "Before",
                    "After",
                    "Between"
                  ],
                  "description": "Operator for filtering dates."
                },
                "field": {
                  "type": "string",
                  "enum": [
                    "updatedDate",
                    "dateCreated"
                  ],
                  "description": "Name of the data attribute to be filtered with values."
                }
              },
              "required": [
                "values",
                "operator"
              ]
            }
          },
          {
            "EnumFilter": {
              "type": "object",
              "properties": {
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "String representing the values of field."
                  }
                },
                "operator": {
                  "type": "string",
                  "enum": [
                    "In",
                    "Not in"
                  ],
                  "description": "Operator for filtering enums."
                },
                "field": {
                  "type": "string",
                  "enum": [
                    "applySources",
                    "language"
                  ],
                  "description": "Name of the data attribute to be filtered with values."
                }
              },
              "required": [
                "values",
                "operator"
              ]
            }
          }
        ]
      }
    },
    "filtersOperator": {
      "type": "string",
      "enum": [
        "AND",
        "OR"
      ],
      "description": "Search operator accepts \"AND\" / \"OR\"."
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "description": "Status returned by the API."
    },
    "data": {
      "type": "array",
      "description": "Candidate Search Response data.",
      "items": {
        "CandidateResponse": {
          "type": "object",
          "description": "An object representing candidate-related information.",
          "properties": {
            "currentjobTitle": {
              "type": "string",
              "description": "A string representing job title of the current company for a given individual."
            },
            "middleName": {
              "type": "string",
              "description": "The middle name of the candidate."
            },
            "candidateId": {
              "type": "string",
              "description": "Unique identifier for the user or candidate."
            },
            "firstName": {
              "type": "string",
              "description": "First name of the candidate."
            },
            "dateCreated": {
              "type": "string",
              "format": "date-time",
              "description": "A timestamp indicating the date and time when the candidate profile was created."
            },
            "updatedDate": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time when the information was last updated."
            },
            "emailList": {
              "type": "array",
              "description": "An array representing an email list.",
              "items": {
                "Email": {
                  "type": "object",
                  "description": "An object representing email-related information.",
                  "properties": {
                    "email": {
                      "type": "string",
                      "description": "String representing the email address in the list."
                    },
                    "type": {
                      "type": "string",
                      "description": "String representing the type of email entry."
                    },
                    "status": {
                      "type": "string",
                      "description": "String representing the status of the email entry."
                    }
                  }
                }
              }
            },
            "contacts": {
              "type": "array",
              "description": "An array representing contact information for the individual.",
              "items": {
                "Contact": {
                  "type": "object",
                  "description": "An object representing contact-related information.",
                  "properties": {
                    "phoneNumber": {
                      "type": "string",
                      "description": "String representing the phone number in the contact entry."
                    },
                    "countryCode": {
                      "type": "string",
                      "description": "String representing the country code of the phone number."
                    },
                    "status": {
                      "type": "string",
                      "description": "String representing the status of the contact entry."
                    },
                    "type": {
                      "type": "string",
                      "description": "String representing the type of contact entry."
                    }
                  }
                }
              }
            },
            "lastName": {
              "type": "string",
              "description": "A string representing the last name of the individual."
            },
            "location": {
              "type": "string",
              "description": "A string representing the location detail of the individual."
            },
            "internal": {
              "type": "boolean",
              "description": "A boolean indicating whether the individual is internal to the organization."
            }
          }
        }
      }
    },
    "totalCount": {
      "type": "integer",
      "description": "Total number of candidates matching the search criteria."
    },
    "startIndex": {
      "type": "integer",
      "description": "Starting index of the returned candidates."
    },
    "paginationSize": {
      "type": "integer",
      "description": "The maximum number of candidates to be returned per page"
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "description": "Status returned by the API."
    },
    "message": {
      "type": "string",
      "description": "Error Message."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing an error response.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code indicating the error status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the error."
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "String representing the values of field."
      }
    },
    "operator": {
      "type": "string",
      "enum": [
        "Is",
        "Is not",
        "Contains",
        "Does not contain",
        "Starts with",
        "Ends with"
      ],
      "description": "Operator for filtering strings."
    },
    "field": {
      "type": "string",
      "enum": [
        "firstName",
        "currentCompany.jobTitle",
        "skillList.value",
        "trafficSourceList.sourceShortName",
        "experience.jobLocation",
        "experience.jobTitle",
        "education.degree",
        "highestEducation.degree",
        "education.fieldOfStudy",
        "preferredLocationList.location",
        "newLocation.city",
        "newLocation.country",
        "emailList.email",
        "languageKnown",
        "lastName",
        "newLocation.state",
        "newLocation.zipCode"
      ],
      "description": "Name of the data attribute to be filtered with values."
    }
  },
  "required": [
    "values",
    "operator"
  ]
}

copied!
{
  "type": "object",
  "properties": {
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "date",
        "description": "String representing the values of date filter."
      }
    },
    "operator": {
      "type": "string",
      "enum": [
        "Equal to",
        "Not equal to",
        "Before",
        "After",
        "Between"
      ],
      "description": "Operator for filtering dates."
    },
    "field": {
      "type": "string",
      "enum": [
        "updatedDate",
        "dateCreated"
      ],
      "description": "Name of the data attribute to be filtered with values."
    }
  },
  "required": [
    "values",
    "operator"
  ]
}

copied!
{
  "type": "object",
  "properties": {
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "String representing the values of field."
      }
    },
    "operator": {
      "type": "string",
      "enum": [
        "In",
        "Not in"
      ],
      "description": "Operator for filtering enums."
    },
    "field": {
      "type": "string",
      "enum": [
        "applySources",
        "language"
      ],
      "description": "Name of the data attribute to be filtered with values."
    }
  },
  "required": [
    "values",
    "operator"
  ]
}

copied!
{
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean",
      "description": "The boolean value to filter by."
    },
    "operator": {
      "type": "string",
      "enum": [
        "True",
        "False"
      ],
      "description": "Operator for filtering booleans."
    },
    "field": {
      "type": "string",
      "enum": [
        "internal",
        "jtcCandidates"
      ],
      "description": "Name of the data attribute to be filtered with values."
    }
  },
  "required": [
    "value",
    "operator"
  ]
}

copied!
{
  "type": "object",
  "description": "An object representing candidate-related information.",
  "properties": {
    "currentjobTitle": {
      "type": "string",
      "description": "A string representing job title of the current company for a given individual."
    },
    "middleName": {
      "type": "string",
      "description": "The middle name of the candidate."
    },
    "candidateId": {
      "type": "string",
      "description": "Unique identifier for the user or candidate."
    },
    "firstName": {
      "type": "string",
      "description": "First name of the candidate."
    },
    "dateCreated": {
      "type": "string",
      "format": "date-time",
      "description": "A timestamp indicating the date and time when the candidate profile was created."
    },
    "updatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the information was last updated."
    },
    "emailList": {
      "type": "array",
      "description": "An array representing an email list.",
      "items": {
        "Email": {
          "type": "object",
          "description": "An object representing email-related information.",
          "properties": {
            "email": {
              "type": "string",
              "description": "String representing the email address in the list."
            },
            "type": {
              "type": "string",
              "description": "String representing the type of email entry."
            },
            "status": {
              "type": "string",
              "description": "String representing the status of the email entry."
            }
          }
        }
      }
    },
    "contacts": {
      "type": "array",
      "description": "An array representing contact information for the individual.",
      "items": {
        "Contact": {
          "type": "object",
          "description": "An object representing contact-related information.",
          "properties": {
            "phoneNumber": {
              "type": "string",
              "description": "String representing the phone number in the contact entry."
            },
            "countryCode": {
              "type": "string",
              "description": "String representing the country code of the phone number."
            },
            "status": {
              "type": "string",
              "description": "String representing the status of the contact entry."
            },
            "type": {
              "type": "string",
              "description": "String representing the type of contact entry."
            }
          }
        }
      }
    },
    "lastName": {
      "type": "string",
      "description": "A string representing the last name of the individual."
    },
    "location": {
      "type": "string",
      "description": "A string representing the location detail of the individual."
    },
    "internal": {
      "type": "boolean",
      "description": "A boolean indicating whether the individual is internal to the organization."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing email-related information.",
  "properties": {
    "email": {
      "type": "string",
      "description": "String representing the email address in the list."
    },
    "type": {
      "type": "string",
      "description": "String representing the type of email entry."
    },
    "status": {
      "type": "string",
      "description": "String representing the status of the email entry."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing contact-related information.",
  "properties": {
    "phoneNumber": {
      "type": "string",
      "description": "String representing the phone number in the contact entry."
    },
    "countryCode": {
      "type": "string",
      "description": "String representing the country code of the phone number."
    },
    "status": {
      "type": "string",
      "description": "String representing the status of the contact entry."
    },
    "type": {
      "type": "string",
      "description": "String representing the type of contact entry."
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "attachments": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "attachmentId": {
                "type": "string",
                "description": "The MD5 checksum of the attachment to be deleted."
              },
              "resumeFileName": {
                "type": "string",
                "description": "The name of the attachment to be deleted."
              },
              "fieldId": {
                "type": "string",
                "description": "The ID of the attachment field to be deleted."
              }
            }
          },
          {
            "anyOf": [
              {
                "required": [
                  "fieldId"
                ]
              },
              {
                "required": [
                  "attachmentId"
                ]
              },
              {
                "required": [
                  "resumeFileName"
                ]
              }
            ]
          }
        ],
        "description": "Attachment object — at least one of fieldId, attachmentId, or resumeFileName is required."
      },
      "description": "Array of attachments to be deleted."
    }
  },
  "description": "Schema defining the structure of the request body for deleting attachments."
}

copied!
{
  "type": "object",
  "properties": {
    "attachment": {
      "type": "string",
      "format": "binary",
      "description": "File to be upload."
    },
    "isParsableResume": {
      "type": "boolean",
      "description": "Flag indicating whether the attachment is parsable."
    }
  },
  "description": "Schema defining the structure of the request body for adding attachments."
}

copied!
{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code indicating the result of the operation."
    },
    "fileUrl": {
      "type": "string",
      "description": "URL pointing to the location of the file which is valid only for 5 minutes."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing additional information about the result."
    },
    "fileName": {
      "type": "string",
      "description": "Name of the file associated with the operation."
    },
    "fileSize": {
      "type": "integer",
      "description": "The size of the file associated with the operation in KBs."
    }
  },
  "required": [
    "status",
    "fileUrl",
    "message",
    "fileName",
    "fileSize"
  ],
  "description": "Schema defining the structure of the response body for presigned url."
}

copied!
{
  "type": "object",
  "description": "Object representing an error response.",
  "properties": {
    "status": {
      "type": "string",
      "description": "HTTP status code indicating the error status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the error."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing an error message.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Description or message providing details about the error."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing an error message.",
  "properties": {}
}

copied!
{
  "type": "object",
  "description": "Response object for updating candidate details.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code indicating the response status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "literalId": {
      "type": "string",
      "description": "Unique identifier for providing details about the response."
    },
    "literalValues": {
      "type": "object",
      "description": "Unique values for providing details about the response."
    },
    "data": {
      "type": "object",
      "description": "Provides details about the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for updating candidate details.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code indicating the response status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "literalId": {
      "type": "string",
      "description": "Unique identifier for providing details about the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing attachments.",
  "properties": {
    "attachments": {
      "type": "array",
      "description": "Array of attachment items.",
      "items": {
        "type": "object",
        "properties": {
          "attachmentId": {
            "type": "string",
            "description": "Unique identifier for the attachment."
          },
          "resumeFileName": {
            "type": "string",
            "description": "Name of the attachment."
          },
          "attachmentType": {
            "type": "string",
            "description": "Type of the attachment."
          },
          "fieldID": {
            "type": "string",
            "description": "fieldId of the attachment."
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "status": {
      "type": "integer",
      "description": "Status code of the response."
    }
  }
}

copied!
{
  "type": "object",
  "required": [
    "firstName",
    "lastName",
    "profileSources"
  ],
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The first name of the candidate."
    },
    "lastName": {
      "type": "string",
      "description": "The last name of the candidate."
    },
    "middleName": {
      "type": "string",
      "description": "The middle name of the candidate."
    },
    "linkedInProfileURL": {
      "type": "string",
      "description": "The LinkedIn profile URL of the candidate."
    },
    "internal": {
      "type": "boolean",
      "description": "Indicates whether the candidate is internal."
    },
    "profileSources": {
      "type": "array",
      "description": "Array of profile sources associated with the candidate.",
      "items": {
        "type": "string"
      }
    },
    "languagePreference": {
      "type": "string",
      "description": "The language preference of the candidate."
    },
    "languageKnown": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of languages known by the candidate."
    },
    "createdDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the candidate was created in the ATS."
    },
    "updatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the candidate record was last updated in the ATS."
    },
    "emailList": {
      "type": "array",
      "description": "Array of email addresses associated with the candidate.",
      "minItems": 1,
      "items": {
        "type": "object",
        "description": "Email details for the candidate.",
        "required": [
          "email",
          "type",
          "status"
        ],
        "properties": {
          "email": {
            "type": "string",
            "description": "The email address of the candidate. (Example: xyz@gmail.com)"
          },
          "type": {
            "type": "string",
            "description": "The type of email (e.g., 'Primary' or 'Secondary')."
          },
          "status": {
            "type": "string",
            "description": "The status of the email (e.g., 'Primary' or 'Secondary').",
            "enum": [
              "Primary",
              "Secondary"
            ]
          }
        }
      }
    },
    "contacts": {
      "type": "array",
      "description": "Array of contact details associated with the candidate.",
      "minItems": 1,
      "items": {
        "type": "object",
        "description": "Contact details for the candidate.",
        "required": [
          "type",
          "phoneNumber",
          "status",
          "countryCode"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of contact (e.g., 'Primary' or 'Secondary')."
          },
          "phoneNumber": {
            "type": "string",
            "description": "The phone number of the contact."
          },
          "status": {
            "type": "string",
            "description": "The status of the contact (e.g., 'Primary' or 'Secondary').",
            "enum": [
              "Primary",
              "Secondary"
            ]
          },
          "countryCode": {
            "type": "string",
            "description": "The country code associated with the contact."
          }
        }
      }
    },
    "atsId": {
      "type": "string",
      "description": "The ATS (Applicant Tracking System) identifier associated with the candidate."
    },
    "employeeId": {
      "type": "string",
      "description": "The employee identifier associated with the candidate."
    }
  },
  "anyOf": [
    {
      "required": [
        "emailList"
      ]
    },
    {
      "required": [
        "contacts"
      ]
    },
    {
      "required": [
        "linkedInProfileURL"
      ]
    },
    {
      "required": [
        "employeeId"
      ]
    }
  ],
  "description": "Schema defining the structure of the request body for creating a candidate profile.<br/><br/><b>Validation Rules:</b><ul><li><code>firstName</code>, <code>lastName</code>, and <code>profileSources</code> are always mandatory.</li><li>You must also provide <b>at least one</b> of the following: <code>emailList</code>, <code>contacts</code>, <code>linkedInProfileURL</code>, or <code>employeeId</code>.</li></ul>"
}

copied!
{
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The first name of the candidate."
    },
    "lastName": {
      "type": "string",
      "description": "The last name of the candidate."
    },
    "middleName": {
      "type": "string",
      "description": "The middle name of the candidate."
    },
    "emailList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "The email address of the candidate."
          },
          "type": {
            "type": "string",
            "description": "The type of email (e.g., 'Primary' or 'Secondary')."
          },
          "status": {
            "type": "string",
            "description": "The status of the email (e.g., 'Primary' or 'Secondary')."
          }
        }
      },
      "description": "Array of email addresses associated with the candidate."
    },
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of contact (e.g., 'Primary' or 'Secondary')."
          },
          "phoneNumber": {
            "type": "string",
            "description": "The phone number of the contact."
          },
          "status": {
            "type": "string",
            "description": "The status of the contact (e.g., 'Primary' or 'Secondary')."
          },
          "countryCode": {
            "type": "string",
            "description": "The country code associated with the contact."
          }
        }
      },
      "description": "Array of contact details associated with the candidate."
    },
    "linkedInProfileURL": {
      "type": "string",
      "description": "The LinkedIn profile URL of the candidate."
    },
    "atsId": {
      "type": "string",
      "description": "The ATS (Applicant Tracking System) identifier associated with the candidate."
    },
    "employeeId": {
      "type": "string",
      "description": "The employee identifier associated with the candidate."
    },
    "internal": {
      "type": "boolean",
      "description": "Indicates whether the candidate is internal."
    },
    "profileSources": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of profile sources associated with the candidate."
    },
    "createdDate": {
      "type": "string",
      "description": "The date and time when the candidate was created in the ATS."
    },
    "updatedDate": {
      "type": "string",
      "description": "The date and time when the candidate record was last updated in the ATS."
    },
    "languagePreference": {
      "type": "string",
      "description": "The language preference of the candidate."
    },
    "languageKnown": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of languages known by the candidate."
    },
    "gender": {
      "type": "string",
      "description": "The gender of the candidate."
    },
    "designation": {
      "type": "string",
      "description": "The designation or job title of the candidate."
    },
    "race": {
      "type": "string",
      "description": "The race or ethnicity of the candidate."
    },
    "veteran": {
      "type": "string",
      "description": "Indicates whether the candidate is a veteran."
    },
    "disability": {
      "type": "string",
      "description": "The disability status of the candidate."
    },
    "ethnicity": {
      "type": "string",
      "description": "The ethnicity of the candidate."
    }
  },
  "description": "Schema defining the structure of the request body for updating a candidate profile."
}

copied!
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates modifying or replacing existing resource.Accepted values are replace and merge"
    },
    "experience": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "company": {
            "type": "string",
            "description": "The name of the company where the candidate gained experience."
          },
          "isCurrent": {
            "type": "boolean",
            "description": "Indicates whether the candidate is currently employed in this position."
          },
          "jobTitle": {
            "type": "string",
            "description": "The job title or position held by the candidate."
          },
          "jobSummary": {
            "type": "string",
            "description": "A summary or description of the candidate's job responsibilities."
          },
          "startMonth": {
            "type": "integer",
            "description": "The starting month of the candidate's employment."
          },
          "startYear": {
            "type": "integer",
            "description": "The starting year of the candidate's employment."
          },
          "endMonth": {
            "type": "integer",
            "description": "The ending month of the candidate's employment, if applicable."
          },
          "endYear": {
            "type": "integer",
            "description": "The ending year of the candidate's employment, if applicable."
          },
          "industry": {
            "type": "string",
            "description": "The industry or sector associated with the candidate's experience."
          },
          "type": {
            "type": "string",
            "description": "The type of experience (e.g., 'Full-time', 'Part-time')."
          },
          "designation": {
            "type": "string",
            "description": "The designation or role associated with the candidate's experience."
          },
          "role": {
            "type": "string",
            "description": "The specific role or function performed by the candidate."
          },
          "jobLocation": {
            "type": "string",
            "description": "The location of the job or work associated with the experience."
          },
          "country": {
            "type": "string",
            "description": "The country where the candidate gained experience."
          },
          "state": {
            "type": "string",
            "description": "The state or region where the candidate gained experience."
          },
          "city": {
            "type": "string",
            "description": "The city where the candidate gained experience."
          }
        }
      },
      "description": "Array of experiences to be added or updated for the candidate."
    }
  },
  "description": "Schema defining the structure of the request body for adding or updating candidate experiences."
}

copied!
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates modifying or replacing of existing resource.Accepted values are replace and merge"
    },
    "education": {
      "type": "array",
      "description": "List of education details to be added or updated for the candidate.",
      "items": {
        "type": "object",
        "properties": {
          "degree": {
            "type": "string",
            "description": "Degree or qualification obtained in the education."
          },
          "fieldOfStudy": {
            "type": "string",
            "description": "Field of study or major in the education."
          },
          "schoolName": {
            "type": "string",
            "description": "Name of the educational institution or school."
          },
          "startMonth": {
            "type": "integer",
            "description": "Start month of the education (numeric value)."
          },
          "startYear": {
            "type": "integer",
            "description": "Start year of the education (numeric value)."
          },
          "endMonth": {
            "type": "integer",
            "description": "End month of the education (numeric value)."
          },
          "endYear": {
            "type": "integer",
            "description": "End year of the education (numeric value)."
          },
          "isHighEducation": {
            "type": "boolean",
            "description": "Boolean indicating whether the education is a high education level."
          },
          "city": {
            "type": "string",
            "description": "City where the educational institution is located."
          },
          "state": {
            "type": "string",
            "description": "State or region where the educational institution is located."
          },
          "country": {
            "type": "string",
            "description": "Country where the educational institution is located."
          },
          "universityName": {
            "type": "string",
            "description": "Name of the university associated with the education."
          }
        }
      }
    }
  },
  "description": "Schema defining the structure of the request body for adding or updating education details for a candidate."
}

copied!
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates modifying or replacing of existing resource.Accepted values are replace and merge"
    },
    "skillList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "description": "The skill value or name to be added to the candidate's skill list."
          }
        }
      },
      "description": "Array of skills to be added to the candidate's skill list."
    }
  },
  "description": "Schema defining the structure of the request body for adding skills to a candidate."
}

copied!
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates modifying or replacing of existing resource.Accepted values are replace and merge"
    },
    "awards": {
      "type": "array",
      "description": "List of awards to be updated or added to the candidate's profile.",
      "items": {
        "type": "object",
        "properties": {
          "awardedOn": {
            "type": "object",
            "description": "Date when the award was received.",
            "properties": {
              "year": {
                "type": "integer",
                "description": "The year when the award was issued."
              },
              "month": {
                "type": "integer",
                "description": "The month when the award was issued."
              }
            }
          },
          "title": {
            "type": "string",
            "description": "Title of the award."
          },
          "description": {
            "type": "string",
            "description": "Description or details of the award."
          }
        }
      }
    }
  },
  "description": "Schema defining the structure of the request body for updating or adding awards to a candidate's profile."
}

copied!
{
  "type": "object",
  "title": "UpdatePreferredLocationRequest",
  "properties": {
    "action": {
      "type": "string",
      "description": "Action to perform on the preferred locations. Valid values: 'add', 'remove', 'replace'."
    },
    "preferredLocationList": {
      "type": "array",
      "description": "List of preferred locations to be added, removed, or replaced.",
      "items": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "Name or identifier of the preferred location."
          },
          "latLong": {
            "type": "string",
            "description": "Latitude and longitude coordinates of the preferred location."
          },
          "city": {
            "type": "string",
            "description": "City of the preferred location."
          },
          "state": {
            "type": "string",
            "description": "State or region of the preferred location."
          },
          "country": {
            "type": "string",
            "description": "Country of the preferred location."
          },
          "zipCode": {
            "type": "string",
            "description": "ZIP code of the preferred location."
          }
        }
      }
    }
  },
  "description": "Schema defining the structure of the request body for updating preferred locations on a candidate's profile."
}

copied!
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates modifying or replacing of existing resource.Accepted values are replace and merge"
    },
    "certifications": {
      "type": "array",
      "description": "List of certifications to be updated or added to the candidate's profile.",
      "items": {
        "type": "object",
        "properties": {
          "certificationNumber": {
            "type": "string",
            "description": "Unique identifier or number associated with the certification."
          },
          "name": {
            "type": "string",
            "description": "Name or title of the certification."
          },
          "institute": {
            "type": "string",
            "description": "Institute or organization that issued the certification."
          },
          "description": {
            "type": "string",
            "description": "Description or details of the certification."
          },
          "state": {
            "type": "string",
            "description": "State or location where the certification was issued."
          },
          "issuedDate": {
            "type": "object",
            "description": "Date when the certification was issued.",
            "properties": {
              "year": {
                "type": "integer",
                "description": "The year when the certification was issued."
              },
              "month": {
                "type": "integer",
                "description": "The month when the certification was issued."
              }
            }
          },
          "expiryDate": {
            "type": "object",
            "description": "Date when the certification is set to expire.",
            "properties": {
              "year": {
                "type": "integer",
                "description": "The year when the certification is set to expire.."
              },
              "month": {
                "type": "integer",
                "description": "The month when the certification is set to expire.."
              }
            }
          }
        }
      }
    }
  },
  "description": "Schema defining the structure of the request body for updating or adding certifications to a candidate's profile."
}

copied!
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates modifying or replacing of existing resource.Accepted values are replace and merge"
    },
    "addressLogs": {
      "type": "array",
      "description": "List of address logs to be updated for the candidate.",
      "items": {
        "type": "object",
        "properties": {
          "addressLines": {
            "type": "array",
            "description": "Address line of the address.",
            "items": {
              "type": "string"
            }
          },
          "city": {
            "type": "string",
            "description": "City of the address."
          },
          "state": {
            "type": "string",
            "description": "State or region of the address."
          },
          "country": {
            "type": "string",
            "description": "Country of the address."
          },
          "location": {
            "type": "string",
            "description": "General location information (e.g., city center, suburban)."
          },
          "latLong": {
            "type": "string",
            "description": "Latitude and longitude coordinates of the address."
          },
          "zipCode": {
            "type": "string",
            "description": "Postal or ZIP code of the address."
          }
        }
      }
    }
  },
  "description": "Schema defining the structure of the request body for updating address information for a candidate."
}

copied!
{
  "type": "object",
  "description": "Schema defining the structure of the request body for updating additional fields for a candidate.",
  "properties": {
    "additionalFields": {
      "type": "object",
      "description": "Object containing additional fields to be updated for the candidate.",
      "properties": {}
    }
  }
}

copied!
{
  "type": "object",
  "description": "Schema defining the structure of the request body for updating recommendations for a candidate.",
  "properties": {
    "recommendations": {
      "type": "array",
      "description": "List of recommendation objects.",
      "items": {
        "type": "object",
        "description": "Object representing an individual recommendation.",
        "properties": {
          "recommendationText": {
            "type": "string",
            "description": "Text of the recommendation."
          },
          "relation": {
            "type": "string",
            "description": "Relationship or association with the candidate."
          }
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Schema defining the structure of the experience data for a candidate.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Object containing experience-related data.",
      "properties": {
        "experiences": {
          "type": "array",
          "description": "List of experience objects.",
          "items": {
            "type": "object",
            "description": "Object representing an individual experience.",
            "properties": {
              "company": {
                "type": "string",
                "description": "A string representing the name of the company."
              },
              "jobTitle": {
                "type": "string",
                "description": "A string representing the job title."
              },
              "industry": {
                "type": "string",
                "description": "A string representing the industry associated with the experience."
              },
              "role": {
                "type": "string",
                "description": "A string representing the role in the experience."
              },
              "jobLocation": {
                "type": "string",
                "description": "A string representing the location of the job."
              },
              "startDate": {
                "type": "number",
                "description": "A number representing the start date of the experience."
              },
              "endDate": {
                "type": "number",
                "description": "A number representing the end date of the experience."
              },
              "isCurrent": {
                "type": "boolean",
                "description": "A boolean indicating whether the experience is current."
              },
              "companyUrl": {
                "type": "string",
                "description": "A string representing the URL of the company."
              },
              "jobSummary": {
                "type": "string",
                "description": "A string representing a summary of the job experience."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Message or additional information related to the experience data."
    },
    "status": {
      "type": "string",
      "description": "Status of the experience data, indicating success or failure."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing an error response.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code indicating the error status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the error."
    },
    "data": {
      "type": "object",
      "description": "Object providing information supplementing the error response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Failed to create candidate as there is profile exists with given identifiers.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code indicating the error status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the error."
    },
    "data": {
      "type": "object",
      "description": "Object providing information supplementing the error response.",
      "properties": {
        "candidateId": {
          "type": "string",
          "description": "A string representing the existing candidate ID."
        },
        "matchingIdentifierField": {
          "type": "string",
          "description": "A string representing the matching identifier field."
        },
        "matchingIdentifierValue": {
          "type": "string",
          "description": "A string representing the matching value."
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for updating candidate details.",
  "properties": {
    "status": {
      "type": "string",
      "description": "HTTP status code indicating the response status."
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing education details.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Object containing education data.",
      "properties": {
        "educations": {
          "type": "array",
          "description": "Array of education items.",
          "items": {
            "type": "object",
            "properties": {
              "degree": {
                "type": "string",
                "description": "The degree obtained by the candidate in their educational background."
              },
              "fieldOfStudy": {
                "type": "string",
                "description": "The field of study or major in the candidate's educational background."
              },
              "schoolName": {
                "type": "string",
                "description": "The name of the school associated with the candidate's educational background."
              },
              "schoolAndUniversity": {
                "type": "string",
                "description": "Combined name of the school and university associated with the candidate's educational background."
              },
              "state": {
                "type": "string",
                "description": "The state where the educational institution is located."
              },
              "country": {
                "type": "string",
                "description": "The country where the educational institution is located."
              },
              "startDate": {
                "type": "number",
                "description": "The start date of the educational program."
              },
              "endDate": {
                "type": "number",
                "description": "The end date of the educational program."
              },
              "isHighEducation": {
                "type": "boolean",
                "description": "Boolean indicating whether the education is considered high education or not."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "status": {
      "type": "string",
      "description": "Status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing skills.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Object containing skills data.",
      "properties": {
        "skills": {
          "type": "array",
          "description": "Array of skill items.",
          "items": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "description": "The skill value."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "status": {
      "type": "string",
      "description": "Status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing awards.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Object containing awards data.",
      "properties": {
        "awards": {
          "type": "array",
          "description": "Array of award items.",
          "items": {
            "type": "object",
            "properties": {
              "description": {
                "type": "string",
                "description": "Description of the award."
              },
              "title": {
                "type": "string",
                "description": "Title of the award."
              },
              "awardedOn": {
                "type": "object",
                "description": "Object representing the date when the award was awarded.",
                "properties": {
                  "year": {
                    "type": "number",
                    "description": "Year of the award."
                  },
                  "month": {
                    "type": "number",
                    "description": "Month of the award."
                  },
                  "day": {
                    "type": "number",
                    "description": "Day of the award."
                  }
                }
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "status": {
      "type": "string",
      "description": "Status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing certifications.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Object containing certifications data.",
      "properties": {
        "certifications": {
          "type": "array",
          "description": "Array of certification items.",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "The name of the certification."
              },
              "certificationNumber": {
                "type": "string",
                "description": "The unique certification number."
              },
              "institute": {
                "type": "string",
                "description": "The institution or organization that issued the certification."
              },
              "startDate": {
                "type": "number",
                "description": "The numeric representation of the certification start date."
              },
              "issuedDate": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "number",
                    "description": "The year when the certification was issued."
                  },
                  "month": {
                    "type": "number",
                    "description": "The month when the certification was issued."
                  },
                  "day": {
                    "type": "number",
                    "description": "The day when the certification was issued."
                  }
                },
                "description": "The date when the certification was officially issued."
              },
              "expiryDate": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "number",
                    "description": "The year when the certification expires."
                  },
                  "month": {
                    "type": "number",
                    "description": "The month when the certification expires."
                  },
                  "day": {
                    "type": "number",
                    "description": "The day when the certification expires."
                  }
                },
                "description": "The date when the certification expires."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "status": {
      "type": "string",
      "description": "Status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing recommendations.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Object containing recommendations data.",
      "properties": {
        "recommendations": {
          "type": "array",
          "description": "Array of recommendation items.",
          "items": {
            "type": "object",
            "properties": {
              "firstName": {
                "type": "string",
                "description": "First name of the person providing the recommendation."
              },
              "lastName": {
                "type": "string",
                "description": "Last name of the person providing the recommendation."
              },
              "text": {
                "type": "string",
                "description": "Text or content of the recommendation."
              },
              "type": {
                "type": "string",
                "description": "Type or category of the recommendation."
              },
              "relation": {
                "type": "string",
                "description": "Relationship of the person providing the recommendation to the candidate."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Description or message providing details about the response."
    },
    "status": {
      "type": "string",
      "description": "Status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing candidate-related information.",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing candidate data.",
      "properties": {
        "middleName": {
          "type": "string",
          "description": "The middle name of the candidate."
        },
        "candidateId": {
          "type": "string",
          "description": "Unique identifier for the user or candidate."
        },
        "employeeId": {
          "type": "string",
          "description": "Employee profile ID associated with the candidate."
        },
        "linkedInProfileURL": {
          "type": "string",
          "description": "URL to the candidate's LinkedIn profile."
        },
        "firstName": {
          "type": "string",
          "description": "First name of the candidate."
        },
        "company": {
          "type": "string",
          "description": "The name of the company associated with the candidate."
        },
        "createdDate": {
          "type": "number",
          "description": "Timestamp indicating when the profile was created."
        },
        "updatedDate": {
          "type": "number",
          "description": "The date when the information was last updated."
        },
        "emailList": {
          "type": "array",
          "description": "An array representing an email list.",
          "items": {
            "EmailDetail": {
              "type": "object",
              "description": "An object representing details of an email entry.",
              "properties": {
                "email": {
                  "type": "string",
                  "description": "The email address."
                },
                "type": {
                  "type": "string",
                  "description": "The type of email entry."
                },
                "status": {
                  "type": "string",
                  "description": "The status of the email entry."
                }
              }
            }
          }
        },
        "contacts": {
          "type": "array",
          "description": "An array representing contact information.",
          "items": {
            "ContactDetail": {
              "type": "object",
              "description": "An object containing details of a contact entry.",
              "properties": {
                "phoneNumber": {
                  "type": "string",
                  "description": "The phone number."
                },
                "countryCode": {
                  "type": "string",
                  "description": "The country code."
                },
                "status": {
                  "type": "string",
                  "description": "The status of the contact entry."
                },
                "type": {
                  "type": "string",
                  "description": "The type of contact entry."
                }
              }
            }
          }
        },
        "lastName": {
          "type": "string",
          "description": "Last name of the individual."
        },
        "internal": {
          "type": "boolean",
          "description": "Indicates whether the individual is internal."
        },
        "atsId": {
          "type": "string",
          "description": "Unique identifier associated with the ATS."
        },
        "firstProfileSourceList": {
          "type": "array",
          "description": "Array representing the first source of the candidate's profile.",
          "items": {
            "type": "string"
          }
        },
        "profileSourceList": {
          "type": "array",
          "description": "Array representing all the sources of the candidate's profile.",
          "items": {
            "type": "string"
          }
        },
        "linkedInUrnId": {
          "type": "string",
          "description": "LinkedIn URN ID of the candidate."
        },
        "linkedInSyncStatus": {
          "type": "string",
          "description": "Status of LinkedIn sync."
        },
        "linkedInLastSyncDate": {
          "type": "integer",
          "description": "When the candidate profile was synced with LinkedIn."
        },
        "location": {
          "description": "Primary address associated with the candidate.",
          "LocationDetail": {
            "type": "object",
            "description": "An object representing a geographic location.",
            "properties": {
              "city": {
                "type": "string",
                "description": "The city."
              },
              "state": {
                "type": "string",
                "description": "The state."
              },
              "country": {
                "type": "string",
                "description": "The country."
              },
              "zipCode": {
                "type": "string",
                "description": "The zipcode."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Message associated with the response."
    },
    "status": {
      "type": "integer",
      "description": "Status code of the request."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing additional fields related to employee information.",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing additional data fields.",
      "properties": {
        "additionalFields": {
          "type": "object",
          "description": "An object containing specific additional fields.",
          "properties": {}
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the request or response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the request or response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing preferred locations associated with a candidate.",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing data related to preferred locations.",
      "properties": {
        "preferredLocationList": {
          "type": "array",
          "description": "An array representing a list of preferred locations.",
          "items": {
            "type": "object",
            "description": "An object containing details about a preferred location.",
            "properties": {
              "location": {
                "type": "string",
                "description": "A string representing the preferred location."
              },
              "city": {
                "type": "string",
                "description": "A string representing the city of the preferred location."
              },
              "country": {
                "type": "string",
                "description": "A string representing the country of the preferred location."
              },
              "state": {
                "type": "string",
                "description": "A string representing the state of the preferred location."
              },
              "zipCode": {
                "type": "string",
                "description": "A string representing the ZIP code of the preferred location."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the request or response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the request or response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing address information associated with a candidate.",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing data related to the candidate's address.",
      "properties": {
        "address": {
          "type": "array",
          "description": "An array representing a list of addresses associated with the candidate.",
          "items": {
            "type": "object",
            "description": "An object containing details about a specific address.",
            "properties": {
              "city": {
                "type": "string",
                "description": "A string representing the city of the address."
              },
              "state": {
                "type": "string",
                "description": "A string representing the state of the address."
              },
              "country": {
                "type": "string",
                "description": "A string representing the country of the address."
              },
              "zipCode": {
                "type": "string",
                "description": "A string representing the ZIP code of the address."
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing the response after creating a candidate.",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing data related to the created candidate.",
      "properties": {
        "candidateId": {
          "type": "string",
          "description": "The unique identifier for the created candidate."
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "string",
      "description": "An string representing the status of the response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing the response after creating a candidate.",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing data related to the created candidate.",
      "properties": {
        "candidateId": {
          "type": "string",
          "description": "The unique identifier for the created candidate."
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "integer",
      "description": "An integer representing the status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing the response after updating additional fields for a candidate.",
  "properties": {
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing the response after updating recommendations for a candidate.",
  "properties": {
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing the response after updating preferred locations for a candidate.",
  "properties": {
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing the response related to the update of candidate addresses.",
  "properties": {
    "message": {
      "type": "string",
      "description": "A string representing a message or communication associated with the response."
    },
    "status": {
      "type": "string",
      "description": "A string representing the status of the response, indicating success, failure, or another state."
    }
  }
}

copied!
{
  "type": "object",
  "description": "No content in the response"
}

copied!
{
  "type": "object",
  "description": "An object containing details about a candidate attachment.",
  "properties": {
    "resumeFileName": {
      "type": "string",
      "description": "Name of the resume file."
    },
    "attachmentId": {
      "type": "string",
      "description": "ID of the attachment file."
    },
    "attachmentName": {
      "type": "string",
      "description": "Name of the attachment file."
    },
    "isCreatedFromCandidates": {
      "type": "boolean",
      "description": "Indicates whether the attachment is created from candidates."
    },
    "documentType": {
      "type": "string",
      "description": "Type of the document."
    },
    "attachmentType": {
      "type": "string",
      "description": "Type of the attachment."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Object representing an educational background entry.",
  "properties": {
    "degree": {
      "type": "string",
      "description": "The degree obtained."
    },
    "fieldOfStudy": {
      "type": "string",
      "description": "The field of study or major."
    },
    "schoolName": {
      "type": "string",
      "description": "The name of the school."
    },
    "schoolAndUniversity": {
      "type": "string",
      "description": "Combined name of the school and university."
    },
    "state": {
      "type": "string",
      "description": "The state where the institution is located."
    },
    "country": {
      "type": "string",
      "description": "The country where the institution is located."
    },
    "startDate": {
      "type": "number",
      "description": "The start date of the program."
    },
    "endDate": {
      "type": "number",
      "description": "The end date of the program."
    },
    "isHighEducation": {
      "type": "boolean",
      "description": "Indicates if this is higher education."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing preferred communication modes.",
  "properties": {
    "sms": {
      "type": "boolean",
      "description": "Is SMS a preferred communication mode."
    },
    "email": {
      "type": "boolean",
      "description": "Is email a preferred communication mode."
    }
  }
}

copied!
{
  "type": "object",
  "description": "An object representing details of an email entry.",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address."
    },
    "type": {
      "type": "string",
      "description": "The type of email entry."
    },
    "status": {
      "type": "string",
      "description": "The status of the email entry."
    }
  }
}