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": "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",
    "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",
    "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",
    "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": "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",
    "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",
    "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",
    "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": "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 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 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": "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 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 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": "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": "No content in the response"
  }
]

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 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": "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 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 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 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 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": "No content in the response"
  }
]

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 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": "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 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 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 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 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": "No content in the response"
  }
]

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 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": "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 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 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 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 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": "No content in the response"
  }
]

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 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": "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 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 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 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 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": "No content in the response"
  }
]

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 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": "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 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 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 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": "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": "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 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 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": "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": "No content in the response"
  }
]

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 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": "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": "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 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 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": "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": "No content in the response"
  }
]

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 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": "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": "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 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 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 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": "No content in the response"
  }
]

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 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": "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": "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 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 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": "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": "No content in the response"
  }
]

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 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": "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": "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",
    "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",
    "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",
    "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": "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",
    "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",
    "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",
    "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",
    "description": "Object representing an error message.",
    "properties": {}
  }
]

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": {
      "message": {
        "type": "string",
        "description": "Description or message providing details about the error."
      }
    }
  }
]

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": "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": {
      "message": {
        "type": "string",
        "description": "Description or message providing details about the error."
      }
    }
  }
]

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 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": {
      "message": {
        "type": "string",
        "description": "Description or message providing details about the error."
      }
    }
  }
]

copied!
[
  {}
]

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": {
      "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": {
      "message": {
        "type": "string",
        "description": "Description or message providing details about the error."
      }
    }
  }
]

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": {
      "0": "status",
      "1": "fileUrl",
      "2": "message",
      "3": "fileName",
      "4": "fileSize"
    },
    "description": "Schema defining the structure of the response body for presigned url."
  }
]

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": {
      "message": {
        "type": "string",
        "description": "Description or message providing details about the error."
      }
    }
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "description": "The response status.",
        "type": "string"
      },
      "message": {
        "description": "The text to indicate the response.",
        "type": "string"
      },
      "timestamp": {
        "type": "string",
        "description": "The text to indicate the timeStamp when the request is invoked."
      },
      "pagination": {
        "description": "Data to represent the pagination parameters, such as from, size and the total notes available.",
        "type": "object",
        "properties": {
          "total": {
            "description": "The total Number of notes available.",
            "type": "number"
          },
          "size": {
            "description": "The number of notes fetched as part of this request.",
            "type": "number"
          },
          "from": {
            "description": "The number of notes skipped from start, before starting to fetch.",
            "type": "number"
          }
        },
        "required": {
          "0": "total",
          "1": "size",
          "2": "from"
        }
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "decision_status": {
              "type": "string",
              "description": "The decision status."
            },
            "jobId": {
              "description": "The unique identifier for job.",
              "type": "string"
            },
            "noteType": {
              "description": "The type of note.",
              "type": "string"
            },
            "recruiterEmail": {
              "description": "The email of the recruiter.",
              "type": "string"
            },
            "recruiterName": {
              "description": "The name of the recruiter.",
              "type": "string"
            },
            "fromName": {
              "description": "From Name.",
              "type": "string"
            },
            "updatedDate": {
              "description": "The date on which the note has been updated.",
              "type": "string"
            },
            "createdDate": {
              "description": "The date on which note has been created.",
              "type": "string"
            },
            "notes": {
              "description": "The Notes.",
              "type": "string"
            }
          },
          "required": {
            "0": "decision_status",
            "1": "jobId",
            "2": "noteType",
            "3": "recruiterEmail",
            "4": "recruiterName",
            "5": "fromName",
            "6": "updatedDate",
            "7": "createdDate",
            "8": "notes"
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp",
      "3": "pagination",
      "4": "data"
    }
  }
]

copied!
[
  {
    "type": "object",
    "description": "The response to indicate that no data has been found.",
    "properties": {}
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a bad request or failure status."
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "timestamp": {
              "type": "string",
              "description": "A timestamp indicating when the error occurred. This helps in tracking the timing of the error."
            },
            "errorAPI": {
              "type": "string",
              "description": "A string representing the specific API or endpoint where the error occurred."
            },
            "message": {
              "type": "string",
              "description": "A human readable message providing details about the nature of the error and potential solutions."
            }
          },
          "required": {
            "0": "timestamp",
            "1": "errorAPI",
            "2": "message"
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "errors"
    },
    "description": "An error response indicating a bad request, with details about the encountered errors."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'not found' error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'not found' error. It may include details about the resource or item that could not be located."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'not found' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested resource or item was not found, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the operation (e.g., success, failure)."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing details about the operation result."
      },
      "timestamp": {
        "type": "string",
        "description": "Timestamp indicating when the operation was performed."
      },
      "id": {
        "type": "string",
        "description": "Unique Identifier for the Note that has been created."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp",
      "3": "id"
    }
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a bad request or failure status."
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "timestamp": {
              "type": "string",
              "description": "A timestamp indicating when the error occurred. This helps in tracking the timing of the error."
            },
            "errorAPI": {
              "type": "string",
              "description": "A string representing the specific API or endpoint where the error occurred."
            },
            "message": {
              "type": "string",
              "description": "A human readable message providing details about the nature of the error and potential solutions."
            }
          },
          "required": {
            "0": "timestamp",
            "1": "errorAPI",
            "2": "message"
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "errors"
    },
    "description": "An error response indicating a bad request, with details about the encountered errors."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'not found' error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'not found' error. It may include details about the resource or item that could not be located."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'not found' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested resource or item was not found, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the delete operation. It could be a success or failure status."
      },
      "message": {
        "type": "string",
        "description": "A readable message providing additional information about the delete operation."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating the moment when the delete operation was performed. This helps in tracking the timing of the operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    }
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'forbidden' error, indicating that the requested action is not allowed."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'forbidden' error. It includes details about the action that is not permitted."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'forbidden' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested action is forbidden, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'not found' error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'not found' error. It may include details about the resource or item that could not be located."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'not found' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested resource or item was not found, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents an internal server error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the internal server error. It may include details about the nature of the error and potential solutions."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the internal server error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating an internal server error, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the response. It could be a success or failure status."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the response. It may include details about the success or failure."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating the moment when the response was generated. This helps in tracking the timing of the response."
      }
    }
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'forbidden' error, indicating that the requested action is not allowed."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'forbidden' error. It includes details about the action that is not permitted."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'forbidden' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested action is forbidden, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'not found' error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'not found' error. It may include details about the resource or item that could not be located."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'not found' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested resource or item was not found, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents an internal server error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the internal server error. It may include details about the nature of the error and potential solutions."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the internal server error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating an internal server error, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "The status indicating whether the fetch is success or not."
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "recruitersUserId": {
              "type": "string",
              "description": "The user id of the recruiter."
            },
            "companyName": {
              "type": "string",
              "description": "The Name of the Company."
            },
            "newNoteDisplayText": {
              "description": "The text on the note.",
              "type": "string"
            },
            "updatedDate": {
              "description": "The date on which the note has been updated.",
              "type": "string"
            },
            "userId": {
              "description": "The Id of the candidate.",
              "type": "string"
            },
            "jobId": {
              "description": "The Id of the Job.",
              "type": "string"
            },
            "noteType": {
              "description": "The Type of the current Note.",
              "type": "string"
            },
            "createdDate": {
              "description": "The Date on which the note has been created.",
              "type": "string"
            },
            "recruiterName": {
              "description": "The Name of the recruiter who created the note.",
              "type": "string"
            },
            "newNoteText": {
              "description": "The Text on the note.",
              "type": "string"
            },
            "_id": {
              "description": "The unique identifier for the Note.",
              "type": "string"
            },
            "parent": {
              "description": "The unique identifier for candidate.",
              "type": "string"
            },
            "taggedRecruiters": {
              "description": "The id of the user who are tagged in the note.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "asPrivate": {
              "description": "The Boolean value to represent the visibility of note.",
              "type": "boolean"
            }
          }
        }
      }
    }
  }
]

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

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "default": "failure",
        "description": "Indicates the status of the error response. It typically represents an 'unauthorized' request."
      },
      "error": {
        "type": "string",
        "default": "UNAUTHORIZED",
        "description": "A string representing the type of error. It is set to 'UNAUTHORIZED' to indicate that the request lacks proper authorization."
      },
      "message": {
        "type": "string",
        "default": "You are not authorized",
        "description": "A human readable message providing additional information about the 'unauthorized' error. It informs the user that they do not have the necessary authorization for the requested action."
      }
    },
    "description": "An error response indicating that the request lacks proper authorization, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "default": "failure",
        "description": "Indicates the status of the error response. It typically represents a 'forbidden' request."
      },
      "error": {
        "type": "string",
        "default": "ACCESS_DENIED",
        "description": "A string representing the type of error. It is set to 'ACCESS_DENIED' to indicate that the request is forbidden."
      },
      "message": {
        "type": "string",
        "default": "Forbidden, You're not allowed to access this resource / Required flags are not enabled / Required permissions are missing",
        "description": "A human readable message providing additional information about the 'forbidden' error. It informs the user that they are not allowed to access the specified resource."
      }
    },
    "description": "An error response indicating that the request is forbidden, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "default": "failure",
        "description": "Indicates the status of the error response. It typically represents an internal server error."
      },
      "message": {
        "type": "string",
        "default": "Internal Server Error",
        "description": "A human readable message providing additional information about the 'internal server error.' It indicates that there was an issue on the server side."
      }
    },
    "description": "An error response indicating an internal server error, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the response. It could be a success or failure status."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the response. It may include details about the success or failure."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating the moment when the response was generated. This helps in tracking the timing of the response."
      },
      "pagination": {
        "type": "object",
        "properties": {
          "size": {
            "type": "number",
            "description": "The number of activities per page in the pagination."
          },
          "from": {
            "type": "number",
            "description": "The starting index of the activities in the current page."
          },
          "totalCount": {
            "type": "number",
            "description": "The total count of activities across all pages."
          }
        },
        "required": {
          "0": "size",
          "1": "from",
          "2": "totalCount"
        },
        "description": "Information about pagination, including size, start index, and total count."
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "recruitersUserId": {
              "type": "string",
              "description": "The user ID of the recruiter associated with the activity."
            },
            "actionType": {
              "type": "string",
              "description": "The type of action performed, such as 'create', 'update', or 'delete'."
            },
            "createdDate": {
              "type": "string",
              "description": "The timestamp when the activity was created."
            },
            "candidateId": {
              "type": "string",
              "description": "The ID of the candidate related to the activity."
            },
            "actionValue": {
              "type": "string",
              "description": "The value associated with the action."
            },
            "addedNewValue": {
              "type": "string",
              "description": "The new value added during the update action."
            },
            "scopeAttr": {
              "type": "object",
              "properties": {
                "scopeId": {
                  "type": "string",
                  "description": "The ID representing the scope of the activity."
                }
              },
              "required": {
                "0": "scopeId"
              },
              "description": "Information about the scope of the activity."
            },
            "recruiterName": {
              "type": "string",
              "description": "The name of the recruiter associated with the activity."
            }
          },
          "required": {
            "0": "recruitersUserId",
            "1": "actionType",
            "2": "createdDate",
            "3": "candidateId",
            "4": "actionValue",
            "5": "addedNewValue",
            "6": "scopeAttr",
            "7": "recruiterName"
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp",
      "3": "pagination",
      "4": "data"
    }
  }
]

copied!
[
  {
    "type": "object",
    "description": "The response to indicate that no data has been found.",
    "properties": {}
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a bad request or failure status."
      },
      "errors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "timestamp": {
              "type": "string",
              "description": "A timestamp indicating when the error occurred. This helps in tracking the timing of the error."
            },
            "errorAPI": {
              "type": "string",
              "description": "A string representing the specific API or endpoint where the error occurred."
            },
            "message": {
              "type": "string",
              "description": "A human readable message providing details about the nature of the error and potential solutions."
            }
          },
          "required": {
            "0": "timestamp",
            "1": "errorAPI",
            "2": "message"
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "errors"
    },
    "description": "An error response indicating a bad request, with details about the encountered errors."
  }
]

copied!
[
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "description": "Indicates the status of the error response. It typically represents a 'not found' error."
      },
      "message": {
        "type": "string",
        "description": "A human readable message providing additional information about the 'not found' error. It may include details about the resource or item that could not be located."
      },
      "timestamp": {
        "type": "string",
        "description": "A timestamp indicating when the 'not found' error occurred. This helps in tracking the timing of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "timestamp"
    },
    "description": "An error response indicating that the requested resource or item was not found, with details about the encountered issues."
  }
]

copied!
[
  {
    "type": "object",
    "description": "An object representing profile update activities associated with a candidate.",
    "properties": {
      "pagination": {
        "type": "object",
        "description": "An object containing pagination details for the profile update activities.",
        "properties": {
          "size": {
            "type": "number",
            "description": "The size of the page in the pagination."
          },
          "from": {
            "type": "number",
            "description": "The starting index of the page in the pagination."
          },
          "totalCount": {
            "type": "number",
            "description": "The total count of profile update activities."
          }
        }
      },
      "data": {
        "type": "array",
        "description": "An array representing profile update activity details.",
        "items": {
          "type": "object",
          "properties": {
            "recruitersUserId": {
              "type": "string",
              "description": "The user ID of the recruiter associated with the profile update activity."
            },
            "recruiterName": {
              "type": "string",
              "description": "The name of the recruiter associated with the profile update activity."
            },
            "candidateId": {
              "type": "string",
              "description": "The ID of the candidate associated with the profile update activity."
            },
            "actionType": {
              "type": "string",
              "description": "The type of action performed in the profile update activity."
            },
            "createdDate": {
              "type": "number",
              "description": "The date when the profile update activity was created."
            },
            "requestSource": {
              "type": "string",
              "description": "The source from which the profile update activity request originated."
            },
            "additionalFieldName": {
              "type": "string",
              "description": "The name of the additional field associated with the profile update activity."
            },
            "previousValue": {
              "type": "string",
              "description": "The previous value of the updated field."
            },
            "updatedValue": {
              "type": "string",
              "description": "The updated value of the field in the profile update activity."
            },
            "actionValue": {
              "type": "string",
              "description": "The value associated with the action performed in the profile update activity."
            },
            "subject": {
              "type": "string",
              "description": "The subject or topic associated with the profile update activity."
            },
            "content": {
              "type": "string",
              "description": "The content or details of the profile update activity."
            },
            "categoryName": {
              "type": "string",
              "description": "The name of the category associated with the profile update activity."
            },
            "emailResponse": {
              "type": "string",
              "description": "The email response associated with the profile update activity."
            },
            "fromEmail": {
              "type": "string",
              "description": "The email address from which the profile update activity originated."
            },
            "fromName": {
              "type": "string",
              "description": "The name associated with the sender of the profile update activity."
            },
            "toEmail": {
              "type": "string",
              "description": "The email address of the recipient in the profile update activity."
            },
            "toName": {
              "type": "string",
              "description": "The name of the recipient in the profile update activity."
            },
            "recipeName": {
              "type": "string",
              "description": "The name of the recipe associated with the profile update activity."
            },
            "addedNewValue": {
              "type": "string",
              "description": "The newly added value in the profile update activity."
            }
          }
        }
      },
      "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."
      },
      "timestamp": {
        "type": "string",
        "description": "A string representing the timestamp associated with the profile update activities."
      }
    }
  }
]

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 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": "An object representing profile action activities associated with a candidate.",
    "properties": {
      "pagination": {
        "type": "object",
        "description": "An object containing pagination details for the profile action activities.",
        "properties": {
          "size": {
            "type": "number",
            "description": "The size of the page in the pagination."
          },
          "from": {
            "type": "number",
            "description": "The starting index of the page in the pagination."
          },
          "totalCount": {
            "type": "number",
            "description": "The total count of profile action activities."
          }
        }
      },
      "data": {
        "type": "array",
        "description": "An array representing profile action activity details.",
        "items": {
          "type": "object",
          "properties": {
            "recruitersUserId": {
              "type": "string",
              "description": "The user ID of the recruiter associated with the profile action activity."
            },
            "recruiterName": {
              "type": "string",
              "description": "The name of the recruiter associated with the profile action activity."
            },
            "candidateId": {
              "type": "string",
              "description": "The ID of the candidate associated with the profile action activity."
            },
            "actionType": {
              "type": "string",
              "description": "The type of action performed in the profile action activity."
            },
            "createdDate": {
              "type": "number",
              "description": "The date when the profile action activity was created."
            },
            "requestSource": {
              "type": "string",
              "description": "The source from which the profile action activity request originated."
            },
            "additionalFieldName": {
              "type": "string",
              "description": "The name of the additional field associated with the profile action activity."
            },
            "previousValue": {
              "type": "string",
              "description": "The previous value of the updated field."
            },
            "updatedValue": {
              "type": "string",
              "description": "The updated value of the field in the profile action activity."
            },
            "actionValue": {
              "type": "string",
              "description": "The value associated with the action performed in the profile action activity."
            },
            "source": {
              "type": "string",
              "description": "The source or origin of the profile action activity."
            },
            "reason": {
              "type": "string",
              "description": "The reason or justification for the profile action activity."
            },
            "fromName": {
              "type": "string",
              "description": "The name associated with the sender of the profile action activity."
            },
            "toName": {
              "type": "string",
              "description": "The name of the recipient in the profile action activity."
            },
            "categoryName": {
              "type": "string",
              "description": "The name of the category associated with the profile action activity."
            },
            "email": {
              "type": "string",
              "description": "The email associated with the profile action activity."
            },
            "event": {
              "type": "string",
              "description": "The event or occurrence associated with the profile action activity."
            }
          }
        }
      },
      "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."
      },
      "timestamp": {
        "type": "string",
        "description": "A string representing the timestamp associated with the profile action activities."
      }
    }
  }
]

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 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": "Successful API response with status, message, and onboarding payload.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code indicating success."
      },
      "message": {
        "type": "string",
        "description": "Outcome message for the client (e.g. confirmation that candidate data was fetched).",
        "example": "Candidate data fetched successfully"
      },
      "data": {
        "OnboardingData": {
          "type": "object",
          "description": "Payload returned for a successful candidate onboarding fetch: profile and contact data under candidateDetails, and requisition or job context under jobDetails.",
          "properties": {
            "candidateDetails": {
              "CandidateDetails": {
                "type": "object",
                "description": "Candidate profile: emails, phone contacts, identification, education, work history, address, and tenant-specific custom fields.",
                "properties": {
                  "firstName": {
                    "type": "string",
                    "description": "Candidate given name."
                  },
                  "middleName": {
                    "type": "string",
                    "description": "Candidate middle name."
                  },
                  "lastName": {
                    "type": "string",
                    "description": "Candidate family name."
                  },
                  "gender": {
                    "type": "string",
                    "description": "Gender or gender identity as stored for the candidate."
                  },
                  "primaryEmailId": {
                    "type": "string",
                    "description": "Primary email address used for onboarding communications."
                  },
                  "secondaryEmailId": {
                    "type": "string",
                    "description": "Secondary or alternate email address."
                  },
                  "officialEmailId": {
                    "type": "string",
                    "description": "Work or official email address when provided."
                  },
                  "dateOfBirth": {
                    "type": "string",
                    "format": "date",
                    "description": "Date of birth as an ISO 8601 calendar date (YYYY-MM-DD)."
                  },
                  "joiningDate": {
                    "type": "string",
                    "format": "date",
                    "description": "Expected or planned joining date as an ISO 8601 calendar date (YYYY-MM-DD)."
                  },
                  "contacts": {
                    "type": "array",
                    "description": "Ordered list of phone contact entries (e.g. primary and secondary); each item may include type, dial code, and number.",
                    "items": {
                      "CandidateContact": {
                        "type": "object",
                        "description": "A single phone contact line, distinguished by type (for example primary vs secondary).",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Contact slot or role, such as primary or secondary."
                          },
                          "phoneNumber": {
                            "type": "string",
                            "description": "Local phone number without country prefix (when present)."
                          },
                          "countryCode": {
                            "type": "string",
                            "description": "Country or dialing code identifier for the number (format may be tenant-specific, e.g. IND_91)."
                          }
                        }
                      }
                    }
                  },
                  "identificationDetails": {
                    "type": "array",
                    "description": "Government or employer identification documents associated with the candidate.",
                    "items": {
                      "CandidateIdentification": {
                        "type": "object",
                        "description": "One identification document or credential record.",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Kind of identification (e.g. aadhaar, passport)."
                          },
                          "number": {
                            "type": "string",
                            "description": "Document or identification number."
                          },
                          "location": {
                            "type": "string",
                            "description": "Issuing location or jurisdiction, if applicable."
                          },
                          "issuedDate": {
                            "type": "string",
                            "description": "Issue date as returned by the source (empty string if unknown)."
                          },
                          "expiryDate": {
                            "type": "string",
                            "description": "Expiry date as returned by the source (empty string if unknown or not applicable)."
                          },
                          "status": {
                            "type": "string",
                            "description": "Verification or document status when provided."
                          }
                        }
                      }
                    }
                  },
                  "education": {
                    "type": "array",
                    "description": "Education history entries.",
                    "items": {
                      "CandidateEducation": {
                        "type": "object",
                        "description": "A single education record.",
                        "properties": {
                          "degree": {
                            "type": "string",
                            "description": "Degree or qualification title."
                          },
                          "fieldOfStudy": {
                            "type": "string",
                            "description": "Major or field of study."
                          },
                          "schoolName": {
                            "type": "string",
                            "description": "School or institute name."
                          },
                          "schoolAndUniversity": {
                            "type": "string",
                            "description": "Combined campus, university, or location label when provided."
                          },
                          "startDate": {
                            "type": "string",
                            "description": "Program start date (format as returned by the source)."
                          },
                          "endDate": {
                            "type": "string",
                            "description": "Program end date (format as returned by the source)."
                          },
                          "isHighEducation": {
                            "type": "boolean",
                            "description": "Whether this entry is marked as the highest level of education."
                          },
                          "state": {
                            "type": "string",
                            "description": "State or region for the institution."
                          },
                          "country": {
                            "type": "string",
                            "description": "Country for the institution."
                          }
                        }
                      }
                    }
                  },
                  "experience": {
                    "type": "array",
                    "description": "Employment history entries.",
                    "items": {
                      "CandidateExperience": {
                        "type": "object",
                        "description": "A single employment history record.",
                        "properties": {
                          "company": {
                            "type": "string",
                            "description": "Employer or organization name."
                          },
                          "jobTitle": {
                            "type": "string",
                            "description": "Job title at the employer."
                          },
                          "role": {
                            "type": "string",
                            "description": "Role or function (may mirror job title)."
                          },
                          "jobLocation": {
                            "type": "string",
                            "description": "Work location for this role."
                          },
                          "isCurrent": {
                            "type": "string",
                            "description": "Whether this is the current employer (e.g. yes or no as stored in source data)."
                          },
                          "industry": {
                            "type": "string",
                            "description": "Industry sector when captured."
                          },
                          "startDate": {
                            "type": "string",
                            "description": "Employment start date (format as returned by the source)."
                          },
                          "endDate": {
                            "type": "string",
                            "description": "Employment end date (format as returned by the source); empty if current."
                          }
                        }
                      }
                    }
                  },
                  "address": {
                    "description": "Current and permanent residential addresses for the candidate.",
                    "CandidateAddressBlock": {
                      "type": "object",
                      "description": "Current and permanent address lines. Both keys are always present; each value is always a StructuredAddress (never null at this level).",
                      "properties": {
                        "currentAddress": {
                          "description": "Current address of the candidate.",
                          "allOf": {
                            "0": {
                              "StructuredAddress": {
                                "type": "object",
                                "description": "Structured postal address, including optional validity dates for that address.",
                                "properties": {
                                  "addressLine1": {
                                    "type": "string",
                                    "description": "First line of the street address."
                                  },
                                  "addressLine2": {
                                    "type": "string",
                                    "description": "Second line of the street address."
                                  },
                                  "city": {
                                    "type": "string",
                                    "description": "City."
                                  },
                                  "zipCode": {
                                    "type": "string",
                                    "description": "Postal or ZIP code."
                                  },
                                  "country": {
                                    "type": "string",
                                    "description": "Country."
                                  },
                                  "state": {
                                    "type": "string",
                                    "description": "State or region."
                                  },
                                  "startDate": {
                                    "type": "string",
                                    "description": "Start date associated with this address (format as returned by the source)."
                                  },
                                  "endDate": {
                                    "type": "string",
                                    "description": "End date associated with this address (format as returned by the source)."
                                  }
                                }
                              }
                            }
                          }
                        },
                        "permanentAddress": {
                          "description": "Permanent address of the candidate.",
                          "allOf": {
                            "0": {
                              "StructuredAddress": {
                                "type": "object",
                                "description": "Structured postal address, including optional validity dates for that address.",
                                "properties": {
                                  "addressLine1": {
                                    "type": "string",
                                    "description": "First line of the street address."
                                  },
                                  "addressLine2": {
                                    "type": "string",
                                    "description": "Second line of the street address."
                                  },
                                  "city": {
                                    "type": "string",
                                    "description": "City."
                                  },
                                  "zipCode": {
                                    "type": "string",
                                    "description": "Postal or ZIP code."
                                  },
                                  "country": {
                                    "type": "string",
                                    "description": "Country."
                                  },
                                  "state": {
                                    "type": "string",
                                    "description": "State or region."
                                  },
                                  "startDate": {
                                    "type": "string",
                                    "description": "Start date associated with this address (format as returned by the source)."
                                  },
                                  "endDate": {
                                    "type": "string",
                                    "description": "End date associated with this address (format as returned by the source)."
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "additionalFields": {
                    "AdditionalFields": {
                      "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."
                        }
                      }
                    }
                  }
                }
              }
            },
            "jobDetails": {
              "JobDetails": {
                "type": "object",
                "description": "Job or requisition context: top-level fields for common attributes, plus additionalFields for ATS, recruiter or hiring-manager contacts, department, and other tenant-specific job metadata.",
                "properties": {
                  "jobTitle": {
                    "type": "string",
                    "description": "Title of the job or requisition."
                  },
                  "jobId": {
                    "type": "string",
                    "description": "Internal or external job identifier."
                  },
                  "jobLocation": {
                    "type": "string",
                    "description": "Primary job location label or free text."
                  },
                  "jobCategory": {
                    "type": "string",
                    "description": "Category or family of the role."
                  },
                  "positionCode": {
                    "type": "string",
                    "description": "Position or requisition code when used by the tenant."
                  },
                  "positionTitle": {
                    "type": "string",
                    "description": "Position title as distinct from job title when both are maintained."
                  },
                  "department": {
                    "type": "string",
                    "description": "Hiring department or cost center name."
                  },
                  "additionalFields": {
                    "AdditionalFields": {
                      "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": "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 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",
    "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": "number",
                "description": "A timestamp indicating the date and time when the candidate 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": {
                  "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."
      }
    }
  }
]