copied!
{
  "type": "object",
  "properties": {
    "previousHiringStatus": {
      "type": "string",
      "description": "The previous hiring status of the candidate."
    },
    "previousStep": {
      "type": "string",
      "description": "The previous step in the hiring process."
    },
    "hiringStatus": {
      "type": "string",
      "description": "The current hiring status of the candidate."
    },
    "hiringStep": {
      "type": "string",
      "description": "The current step in the hiring process."
    },
    "isRejected": {
      "type": "boolean",
      "description": "A boolean indicating whether the candidate has been rejected."
    },
    "rejectionReason": {
      "type": "string",
      "description": "The reason for candidate rejection."
    },
    "rejectionReasonId": {
      "type": "string",
      "description": "The unique identifier for the rejection reason."
    },
    "rejectCode": {
      "type": "string",
      "description": "The rejection code associated with the rejection."
    },
    "workflowStepId": {
      "type": "string",
      "description": "The unique identifier for the current workflow step."
    },
    "hiringStatusUpdateDate": {
      "type": "string",
      "description": "The date when the hiring status was last updated."
    },
    "currentStatusCode": {
      "type": "string",
      "description": "The current status code of the hiring process."
    },
    "currentStepCode": {
      "type": "string",
      "description": "The current step code of the hiring process."
    },
    "destinationStatusCode": {
      "type": "string",
      "description": "The destination status code for the next step in the hiring process."
    },
    "twoWayRequest": {
      "type": "boolean",
      "description": "A boolean indicating whether the hiring status update is a two-way request."
    },
    "recruiterName": {
      "type": "string",
      "description": "The name of the recruiter making the hiring status update."
    },
    "recruiterEmail": {
      "type": "string",
      "description": "The email address of the recruiter making the hiring status update."
    },
    "recruiterUserId": {
      "type": "string",
      "description": "The unique identifier for the recruiter making the hiring status update."
    }
  }
}

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

copied!
{
  "type": "object",
  "properties": {
    "jobSpecificAdditionalFields": {
      "type": "object",
      "properties": {}
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {},
      "description": "Additional data related to the update response, specific details may be included here."
    },
    "message": {
      "type": "string",
      "description": "A message providing additional information about the response status or outcome."
    },
    "status": {
      "type": "string",
      "description": "The status of the additional fields update response, indicating success or failure."
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "candidateIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of candidate IDs to be assigned to the specified job."
    },
    "jobId": {
      "type": "string",
      "description": "The unique identifier of the job to which candidates are to be assigned."
    },
    "syncToATS": {
      "type": "boolean",
      "description": "A boolean indicating whether the assignment should be synchronized with the Applicant Tracking System (ATS)."
    },
    "pushToATS": {
      "type": "boolean",
      "description": "A boolean indicating whether the assigned candidates should be pushed to the Applicant Tracking System (ATS)."
    }
  }
}

copied!
{
  "type": "object",
  "properties": {
    "pagination": {
      "type": "object",
      "description": "Pagination information for the list of candidates.",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of candidates in the dataset."
        },
        "size": {
          "type": "number",
          "description": "Number of candidates returned in the current response."
        },
        "from": {
          "type": "number",
          "description": "Index of the first candidate in the current result set."
        }
      }
    },
    "data": {
      "type": "object",
      "description": "Data object containing information about the candidates.",
      "properties": {
        "candidates": {
          "type": "array",
          "description": "Array of candidate objects containing their details.",
          "items": {
            "type": "object",
            "description": "Details of an individual candidate.",
            "properties": {
              "emails": {
                "type": "array",
                "description": "Array of email addresses associated with the candidate.",
                "items": {
                  "type": "string"
                }
              },
              "lastName": {
                "type": "string",
                "description": "Last name of the candidate."
              },
              "firstName": {
                "type": "string",
                "description": "First name of the candidate."
              },
              "dateCreated": {
                "type": "string",
                "description": "Date when the candidate record was created."
              },
              "hiringStatus": {
                "type": "string",
                "description": "Current hiring status of the candidate."
              },
              "updatedDate": {
                "type": "string",
                "description": "Date when the candidate record was last updated."
              },
              "userId": {
                "type": "string",
                "description": "Unique identifier for the candidate user."
              },
              "contacts": {
                "type": "array",
                "description": "Array of contact details associated with the candidate.",
                "items": {
                  "type": "object",
                  "description": "Details of an individual contact associated with the candidate.",
                  "properties": {
                    "originalNumber": {
                      "type": "string",
                      "description": "The phone number of the contact."
                    },
                    "phoneNumber": {
                      "type": "string",
                      "description": "The phone number of the contact."
                    },
                    "phoneNumberWithoutCountryCode": {
                      "type": "string",
                      "description": "The phone number without country code"
                    },
                    "countryCode": {
                      "type": "string",
                      "description": "The country code associated with the contact."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Additional information or a message related to the response."
    },
    "status": {
      "type": "string",
      "description": "The status of the response, indicating success or failure."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Represents a bad request scenario with an associated error message.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message indicating the nature of the bad request."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Represents a general error scenario with status information and an associated error message.",
  "properties": {
    "status": {
      "type": "string",
      "description": "Status code or identifier indicating the nature of the error."
    },
    "message": {
      "type": "string",
      "description": "Error message providing details about the encountered issue."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Represents a general error scenario with status information and an associated error message.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "Status code or identifier indicating the nature of the error."
    },
    "message": {
      "type": "string",
      "description": "Error message providing details about the encountered issue."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Represents information about the next hiring status.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Details related to the hiring status data.",
      "properties": {
        "hiringStatusList": {
          "type": "array",
          "description": "List of hiring statuses and their properties.",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the hiring status."
              },
              "isRejected": {
                "type": "boolean",
                "description": "Flag indicating whether the hiring status is rejected."
              },
              "isDefault": {
                "type": "boolean",
                "description": "Flag indicating whether the hiring status is the default."
              },
              "statusCode": {
                "type": "string",
                "description": "Status code of the hiring status."
              },
              "step": {
                "type": "string",
                "description": "Current step in the workflow for the hiring status."
              },
              "transitionStatuses": {
                "type": "array",
                "description": "List of transition statuses for the current hiring status.",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the transition status."
                    },
                    "statusCode": {
                      "type": "string",
                      "description": "Status code of the transition status."
                    },
                    "isRejected": {
                      "type": "boolean",
                      "description": "Flag indicating whether the transition status is rejected."
                    },
                    "isDefault": {
                      "type": "boolean",
                      "description": "Flag indicating whether the transition status is the default."
                    },
                    "step": {
                      "type": "string",
                      "description": "Current step in the workflow for the transition status."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Message associated with the response."
    },
    "status": {
      "type": "string",
      "description": "Status of the response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Information related to the hiring status.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Message associated with the response."
    },
    "status": {
      "type": "number",
      "description": "Status of the response."
    },
    "data": {
      "description": "Data related to the hiring status.",
      "Application": {
        "type": "object",
        "description": "Details of a single application.",
        "properties": {
          "jobId": {
            "type": "string",
            "description": "ID of the job associated with the application."
          },
          "jobTitle": {
            "type": "string",
            "description": "Title of the job associated with the application."
          },
          "jobAssociationType": {
            "type": "string",
            "description": "Indicates how a candidate is related to a job, based on their level of engagement (e.g., Applied)."
          },
          "hiringStatus": {
            "HiringStatusDetail": {
              "type": "object",
              "description": "Detailed information regarding the current hiring status and workflow step.",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "A string related to the value of the hiring status."
                },
                "step": {
                  "type": "string",
                  "description": "A string related to the step value of the hiring status."
                },
                "hiringStatusCode": {
                  "type": "string",
                  "description": "A string related to the code of the hiring status value."
                },
                "hiringStepCode": {
                  "type": "string",
                  "description": "A string related to the value of the hiring status step."
                },
                "disposition": {
                  "type": "string",
                  "description": "A string related to the disposition of the hiring status."
                },
                "previousValue": {
                  "type": "string",
                  "description": "A string related to the previous value of the hiring status."
                },
                "previousStep": {
                  "type": "string",
                  "description": "A string related to the step value of the hiring status."
                },
                "updatedDate": {
                  "type": "number",
                  "description": "A number related to the updated date of the hiring status."
                },
                "workFlowStepId": {
                  "type": "string",
                  "description": "A string related to the work flow step id of the hiring status."
                },
                "hsPriority": {
                  "type": "number",
                  "description": "A string related to the hiring status priority."
                },
                "previousWorkFlowStepId": {
                  "type": "string",
                  "description": "A string related to the previous work flow step id of the hiring status."
                },
                "rejectionReason": {
                  "type": "string",
                  "description": "A string related to the rejection reason."
                },
                "rejectionReasonId": {
                  "type": "string",
                  "description": "A string related to the rejection reason id."
                },
                "previousHiringStatusCode": {
                  "type": "string",
                  "description": "A string related to the previous hiring status code."
                },
                "previousHiringStepCode": {
                  "type": "string",
                  "description": "A string related to the previous hiring status step code."
                },
                "previousRejectionReason": {
                  "type": "string",
                  "description": "A string related to the previous rejection reason."
                },
                "previousRejectionReasonId": {
                  "type": "string",
                  "description": "A string related to the previous rejection reason id."
                },
                "isRejected": {
                  "type": "boolean",
                  "description": "A boolean related to the rejection status."
                }
              }
            }
          },
          "candidateId": {
            "type": "string",
            "description": "ID of the user associated with the application."
          },
          "jobCategory": {
            "type": "string",
            "description": "Category of the job associated with the application."
          },
          "crmJobSeekerId": {
            "type": "string",
            "description": "CRM ID of the job seeker."
          },
          "phApplicationId": {
            "type": "string",
            "description": "Phenom application ID."
          },
          "createdDate": {
            "type": "number",
            "description": "A number related to the created date."
          },
          "updatedDate": {
            "type": "number",
            "description": "A number related to the updated date."
          },
          "atsId": {
            "type": "string",
            "description": "A string related to the ats id."
          },
          "applicationId": {
            "type": "string",
            "description": "A string related to the application id."
          },
          "isConfidential": {
            "type": "boolean",
            "description": "A boolean related to the confidential status."
          },
          "appliedEmail": {
            "type": "string",
            "description": "A string related to the applied email."
          },
          "trafficSourceList": {
            "type": "array",
            "description": "Array of traffic sources for this application.",
            "items": {
              "TrafficSourceDetail": {
                "type": "object",
                "description": "Details about the source of traffic or referral.",
                "properties": {
                  "sourceShortName": {
                    "type": "string",
                    "description": "A string related to the source short name."
                  },
                  "sourceFullname": {
                    "type": "string",
                    "description": "A string related to the source full name."
                  },
                  "referralType": {
                    "type": "string",
                    "description": "A string related to the referral type."
                  },
                  "createdDate": {
                    "type": "number",
                    "description": "A number related to the created date."
                  },
                  "activityTypes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "An array related to the activity types."
                  },
                  "utmMedium": {
                    "type": "string",
                    "description": "A string related to the UTM medium."
                  },
                  "utmCampaign": {
                    "type": "string",
                    "description": "A string related to the UTM campaign."
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

copied!
{
  "type": "array",
  "description": "Draft applications.",
  "items": {
    "type": "object",
    "description": "Details of a draft application.",
    "properties": {
      "hiringStatus": {
        "type": "object",
        "description": "Details of the hiring status for the application.",
        "properties": {
          "updatedDate": {
            "type": "number",
            "description": "Date when the hiring status was last updated."
          },
          "value": {
            "type": "string",
            "description": "Current value of the hiring status."
          },
          "hsPriority": {
            "type": "number",
            "description": "Priority associated with the hiring status."
          },
          "previousRejectionReasonId": {
            "type": "string",
            "description": "ID of the previous rejection reason."
          },
          "rejectionReasonId": {
            "type": "string",
            "description": "ID of the current rejection reason."
          },
          "rejectionReason": {
            "type": "string",
            "description": "Current rejection reason."
          },
          "previousRejectionReason": {
            "type": "string",
            "description": "Previous rejection reason."
          },
          "previousValue": {
            "type": "string",
            "description": "Previous value of the hiring status."
          },
          "isRejected": {
            "type": "boolean",
            "description": "Indicates whether the application is rejected."
          },
          "step": {
            "type": "string",
            "description": "Current step in the workflow."
          },
          "workFlowStepId": {
            "type": "string",
            "description": "ID of the current workflow step."
          },
          "previousWorkFlowStepId": {
            "type": "string",
            "description": "ID of the previous workflow step."
          }
        }
      },
      "jobCategory": {
        "type": "string",
        "description": "Category of the job associated with the application."
      },
      "jobId": {
        "type": "string",
        "description": "ID of the job associated with the application."
      },
      "jobTitle": {
        "type": "string",
        "description": "Title of the job associated with the application."
      },
      "userId": {
        "type": "string",
        "description": "ID of the user associated with the application."
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for updating hiring status.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Empty data object for hiring status update response.",
      "properties": {}
    },
    "message": {
      "type": "string",
      "description": "A message related to the hiring status update."
    },
    "status": {
      "type": "string",
      "description": "The overall status of the hiring status update process."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response containing candidate application details.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Message associated with the response."
    },
    "status": {
      "type": "number",
      "description": "Status code of the response."
    },
    "data": {
      "type": "object",
      "description": "Data related to the candidate applications.",
      "properties": {
        "applications": {
          "type": "array",
          "description": "List of applications for the candidate.",
          "items": {
            "Application": {
              "type": "object",
              "description": "Details of a single application.",
              "properties": {
                "jobId": {
                  "type": "string",
                  "description": "ID of the job associated with the application."
                },
                "jobTitle": {
                  "type": "string",
                  "description": "Title of the job associated with the application."
                },
                "jobAssociationType": {
                  "type": "string",
                  "description": "Indicates how a candidate is related to a job, based on their level of engagement (e.g., Applied)."
                },
                "hiringStatus": {
                  "HiringStatusDetail": {
                    "type": "object",
                    "description": "Detailed information regarding the current hiring status and workflow step.",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "A string related to the value of the hiring status."
                      },
                      "step": {
                        "type": "string",
                        "description": "A string related to the step value of the hiring status."
                      },
                      "hiringStatusCode": {
                        "type": "string",
                        "description": "A string related to the code of the hiring status value."
                      },
                      "hiringStepCode": {
                        "type": "string",
                        "description": "A string related to the value of the hiring status step."
                      },
                      "disposition": {
                        "type": "string",
                        "description": "A string related to the disposition of the hiring status."
                      },
                      "previousValue": {
                        "type": "string",
                        "description": "A string related to the previous value of the hiring status."
                      },
                      "previousStep": {
                        "type": "string",
                        "description": "A string related to the step value of the hiring status."
                      },
                      "updatedDate": {
                        "type": "number",
                        "description": "A number related to the updated date of the hiring status."
                      },
                      "workFlowStepId": {
                        "type": "string",
                        "description": "A string related to the work flow step id of the hiring status."
                      },
                      "hsPriority": {
                        "type": "number",
                        "description": "A string related to the hiring status priority."
                      },
                      "previousWorkFlowStepId": {
                        "type": "string",
                        "description": "A string related to the previous work flow step id of the hiring status."
                      },
                      "rejectionReason": {
                        "type": "string",
                        "description": "A string related to the rejection reason."
                      },
                      "rejectionReasonId": {
                        "type": "string",
                        "description": "A string related to the rejection reason id."
                      },
                      "previousHiringStatusCode": {
                        "type": "string",
                        "description": "A string related to the previous hiring status code."
                      },
                      "previousHiringStepCode": {
                        "type": "string",
                        "description": "A string related to the previous hiring status step code."
                      },
                      "previousRejectionReason": {
                        "type": "string",
                        "description": "A string related to the previous rejection reason."
                      },
                      "previousRejectionReasonId": {
                        "type": "string",
                        "description": "A string related to the previous rejection reason id."
                      },
                      "isRejected": {
                        "type": "boolean",
                        "description": "A boolean related to the rejection status."
                      }
                    }
                  }
                },
                "candidateId": {
                  "type": "string",
                  "description": "ID of the user associated with the application."
                },
                "jobCategory": {
                  "type": "string",
                  "description": "Category of the job associated with the application."
                },
                "crmJobSeekerId": {
                  "type": "string",
                  "description": "CRM ID of the job seeker."
                },
                "phApplicationId": {
                  "type": "string",
                  "description": "Phenom application ID."
                },
                "createdDate": {
                  "type": "number",
                  "description": "A number related to the created date."
                },
                "updatedDate": {
                  "type": "number",
                  "description": "A number related to the updated date."
                },
                "atsId": {
                  "type": "string",
                  "description": "A string related to the ats id."
                },
                "applicationId": {
                  "type": "string",
                  "description": "A string related to the application id."
                },
                "isConfidential": {
                  "type": "boolean",
                  "description": "A boolean related to the confidential status."
                },
                "appliedEmail": {
                  "type": "string",
                  "description": "A string related to the applied email."
                },
                "trafficSourceList": {
                  "type": "array",
                  "description": "Array of traffic sources for this application.",
                  "items": {
                    "TrafficSourceDetail": {
                      "type": "object",
                      "description": "Details about the source of traffic or referral.",
                      "properties": {
                        "sourceShortName": {
                          "type": "string",
                          "description": "A string related to the source short name."
                        },
                        "sourceFullname": {
                          "type": "string",
                          "description": "A string related to the source full name."
                        },
                        "referralType": {
                          "type": "string",
                          "description": "A string related to the referral type."
                        },
                        "createdDate": {
                          "type": "number",
                          "description": "A number related to the created date."
                        },
                        "activityTypes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "description": "An array related to the activity types."
                        },
                        "utmMedium": {
                          "type": "string",
                          "description": "A string related to the UTM medium."
                        },
                        "utmCampaign": {
                          "type": "string",
                          "description": "A string related to the UTM campaign."
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response containing candidate lead details.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Message associated with the response."
    },
    "status": {
      "type": "number",
      "description": "Status code of the response."
    },
    "data": {
      "type": "object",
      "description": "Data related to the candidate leads.",
      "properties": {
        "activities": {
          "type": "array",
          "description": "List of leads for the candidate.",
          "items": {
            "Leads": {
              "type": "object",
              "description": "Details of a single lead.",
              "properties": {
                "jobId": {
                  "type": "string",
                  "description": "ID of the job associated with the lead."
                },
                "jobTitle": {
                  "type": "string",
                  "description": "Title of the job associated with the lead."
                },
                "jobAssociationType": {
                  "type": "string",
                  "description": "Indicates how a candidate is related to a job, based on their level of engagement (e.g., Applied)."
                },
                "hiringStatus": {
                  "type": "object",
                  "description": "Details of the hiring status for the activity.",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "A string related to the value of the hiring status."
                    },
                    "step": {
                      "type": "string",
                      "description": "A string related to the step value of the hiring status."
                    },
                    "hiringStatusCode": {
                      "type": "string",
                      "description": "A string related to the code of the hiring status value."
                    },
                    "hiringStepCode": {
                      "type": "string",
                      "description": "A string related to the value of the hiring status step."
                    },
                    "disposition": {
                      "type": "string",
                      "description": "A string related to the disposition of the hiring status."
                    },
                    "previousValue": {
                      "type": "string",
                      "description": "A string related to the previous value of the hiring status."
                    },
                    "previousStep": {
                      "type": "string",
                      "description": "A string related to the step value of the hiring status."
                    },
                    "updatedDate": {
                      "type": "number",
                      "description": "A number related to the updated date of the hiring status."
                    },
                    "workFlowStepId": {
                      "type": "string",
                      "description": "A string related to the work flow step id of the hiring status."
                    },
                    "hsPriority": {
                      "type": "number",
                      "description": "A string related to the hiring status priority."
                    },
                    "previousWorkFlowStepId": {
                      "type": "string",
                      "description": "A string related to the previous work flow step id of the hiring status."
                    },
                    "rejectionReason": {
                      "type": "string",
                      "description": "A string related to the rejection reason."
                    },
                    "rejectionReasonId": {
                      "type": "string",
                      "description": "A string related to the rejection reason id."
                    },
                    "previousHiringStatusCode": {
                      "type": "string",
                      "description": "A string related to the previous hiring status code."
                    },
                    "previousHiringStepCode": {
                      "type": "string",
                      "description": "A string related to the previous hiring status step code."
                    },
                    "previousRejectionReason": {
                      "type": "string",
                      "description": "A string related to the previous rejection reason."
                    },
                    "previousRejectionReasonId": {
                      "type": "string",
                      "description": "A string related to the previous rejection reason id."
                    },
                    "isRejected": {
                      "type": "boolean",
                      "description": "A boolean related to the rejection status."
                    }
                  }
                },
                "candidateId": {
                  "type": "string",
                  "description": "ID of the user associated with the activity."
                },
                "jobCategory": {
                  "type": "string",
                  "description": "Category of the job associated with the activity."
                },
                "crmJobSeekerId": {
                  "type": "string",
                  "description": "CRM ID of the job seeker."
                },
                "createdDate": {
                  "type": "number",
                  "description": "A number related to the created date."
                },
                "updatedDate": {
                  "type": "number",
                  "description": "A number related to the updated date."
                },
                "atsId": {
                  "type": "string",
                  "description": "A string related to the ats id."
                },
                "applicationId": {
                  "type": "string",
                  "description": "A string related to the application id."
                },
                "isConfidential": {
                  "type": "boolean",
                  "description": "A boolean related to the confidential status."
                },
                "trafficSourceList": {
                  "type": "array",
                  "description": "Array of traffic sources for this activity.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "sourceShortName": {
                        "type": "string",
                        "description": "A string related to the source short name."
                      },
                      "sourceFullname": {
                        "type": "string",
                        "description": "A string related to the source full name."
                      },
                      "referralType": {
                        "type": "string",
                        "description": "A string related to the referral type."
                      },
                      "createdDate": {
                        "type": "number",
                        "nullable": true,
                        "description": "A number related to the created date."
                      },
                      "activityTypes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "An array related to the activity types."
                      },
                      "utmMedium": {
                        "type": "string",
                        "nullable": true,
                        "description": "A string related to the UTM medium."
                      },
                      "utmCampaign": {
                        "type": "string",
                        "nullable": true,
                        "description": "A string related to the UTM campaign."
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Details of a single application.",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "ID of the job associated with the application."
    },
    "jobTitle": {
      "type": "string",
      "description": "Title of the job associated with the application."
    },
    "jobAssociationType": {
      "type": "string",
      "description": "Indicates how a candidate is related to a job, based on their level of engagement (e.g., Applied)."
    },
    "hiringStatus": {
      "HiringStatusDetail": {
        "type": "object",
        "description": "Detailed information regarding the current hiring status and workflow step.",
        "properties": {
          "value": {
            "type": "string",
            "description": "A string related to the value of the hiring status."
          },
          "step": {
            "type": "string",
            "description": "A string related to the step value of the hiring status."
          },
          "hiringStatusCode": {
            "type": "string",
            "description": "A string related to the code of the hiring status value."
          },
          "hiringStepCode": {
            "type": "string",
            "description": "A string related to the value of the hiring status step."
          },
          "disposition": {
            "type": "string",
            "description": "A string related to the disposition of the hiring status."
          },
          "previousValue": {
            "type": "string",
            "description": "A string related to the previous value of the hiring status."
          },
          "previousStep": {
            "type": "string",
            "description": "A string related to the step value of the hiring status."
          },
          "updatedDate": {
            "type": "number",
            "description": "A number related to the updated date of the hiring status."
          },
          "workFlowStepId": {
            "type": "string",
            "description": "A string related to the work flow step id of the hiring status."
          },
          "hsPriority": {
            "type": "number",
            "description": "A string related to the hiring status priority."
          },
          "previousWorkFlowStepId": {
            "type": "string",
            "description": "A string related to the previous work flow step id of the hiring status."
          },
          "rejectionReason": {
            "type": "string",
            "description": "A string related to the rejection reason."
          },
          "rejectionReasonId": {
            "type": "string",
            "description": "A string related to the rejection reason id."
          },
          "previousHiringStatusCode": {
            "type": "string",
            "description": "A string related to the previous hiring status code."
          },
          "previousHiringStepCode": {
            "type": "string",
            "description": "A string related to the previous hiring status step code."
          },
          "previousRejectionReason": {
            "type": "string",
            "description": "A string related to the previous rejection reason."
          },
          "previousRejectionReasonId": {
            "type": "string",
            "description": "A string related to the previous rejection reason id."
          },
          "isRejected": {
            "type": "boolean",
            "description": "A boolean related to the rejection status."
          }
        }
      }
    },
    "candidateId": {
      "type": "string",
      "description": "ID of the user associated with the application."
    },
    "jobCategory": {
      "type": "string",
      "description": "Category of the job associated with the application."
    },
    "crmJobSeekerId": {
      "type": "string",
      "description": "CRM ID of the job seeker."
    },
    "phApplicationId": {
      "type": "string",
      "description": "Phenom application ID."
    },
    "createdDate": {
      "type": "number",
      "description": "A number related to the created date."
    },
    "updatedDate": {
      "type": "number",
      "description": "A number related to the updated date."
    },
    "atsId": {
      "type": "string",
      "description": "A string related to the ats id."
    },
    "applicationId": {
      "type": "string",
      "description": "A string related to the application id."
    },
    "isConfidential": {
      "type": "boolean",
      "description": "A boolean related to the confidential status."
    },
    "appliedEmail": {
      "type": "string",
      "description": "A string related to the applied email."
    },
    "trafficSourceList": {
      "type": "array",
      "description": "Array of traffic sources for this application.",
      "items": {
        "TrafficSourceDetail": {
          "type": "object",
          "description": "Details about the source of traffic or referral.",
          "properties": {
            "sourceShortName": {
              "type": "string",
              "description": "A string related to the source short name."
            },
            "sourceFullname": {
              "type": "string",
              "description": "A string related to the source full name."
            },
            "referralType": {
              "type": "string",
              "description": "A string related to the referral type."
            },
            "createdDate": {
              "type": "number",
              "description": "A number related to the created date."
            },
            "activityTypes": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "An array related to the activity types."
            },
            "utmMedium": {
              "type": "string",
              "description": "A string related to the UTM medium."
            },
            "utmCampaign": {
              "type": "string",
              "description": "A string related to the UTM campaign."
            }
          }
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Details of a single lead.",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "ID of the job associated with the lead."
    },
    "jobTitle": {
      "type": "string",
      "description": "Title of the job associated with the lead."
    },
    "jobAssociationType": {
      "type": "string",
      "description": "Indicates how a candidate is related to a job, based on their level of engagement (e.g., Applied)."
    },
    "hiringStatus": {
      "type": "object",
      "description": "Details of the hiring status for the activity.",
      "properties": {
        "value": {
          "type": "string",
          "description": "A string related to the value of the hiring status."
        },
        "step": {
          "type": "string",
          "description": "A string related to the step value of the hiring status."
        },
        "hiringStatusCode": {
          "type": "string",
          "description": "A string related to the code of the hiring status value."
        },
        "hiringStepCode": {
          "type": "string",
          "description": "A string related to the value of the hiring status step."
        },
        "disposition": {
          "type": "string",
          "description": "A string related to the disposition of the hiring status."
        },
        "previousValue": {
          "type": "string",
          "description": "A string related to the previous value of the hiring status."
        },
        "previousStep": {
          "type": "string",
          "description": "A string related to the step value of the hiring status."
        },
        "updatedDate": {
          "type": "number",
          "description": "A number related to the updated date of the hiring status."
        },
        "workFlowStepId": {
          "type": "string",
          "description": "A string related to the work flow step id of the hiring status."
        },
        "hsPriority": {
          "type": "number",
          "description": "A string related to the hiring status priority."
        },
        "previousWorkFlowStepId": {
          "type": "string",
          "description": "A string related to the previous work flow step id of the hiring status."
        },
        "rejectionReason": {
          "type": "string",
          "description": "A string related to the rejection reason."
        },
        "rejectionReasonId": {
          "type": "string",
          "description": "A string related to the rejection reason id."
        },
        "previousHiringStatusCode": {
          "type": "string",
          "description": "A string related to the previous hiring status code."
        },
        "previousHiringStepCode": {
          "type": "string",
          "description": "A string related to the previous hiring status step code."
        },
        "previousRejectionReason": {
          "type": "string",
          "description": "A string related to the previous rejection reason."
        },
        "previousRejectionReasonId": {
          "type": "string",
          "description": "A string related to the previous rejection reason id."
        },
        "isRejected": {
          "type": "boolean",
          "description": "A boolean related to the rejection status."
        }
      }
    },
    "candidateId": {
      "type": "string",
      "description": "ID of the user associated with the activity."
    },
    "jobCategory": {
      "type": "string",
      "description": "Category of the job associated with the activity."
    },
    "crmJobSeekerId": {
      "type": "string",
      "description": "CRM ID of the job seeker."
    },
    "createdDate": {
      "type": "number",
      "description": "A number related to the created date."
    },
    "updatedDate": {
      "type": "number",
      "description": "A number related to the updated date."
    },
    "atsId": {
      "type": "string",
      "description": "A string related to the ats id."
    },
    "applicationId": {
      "type": "string",
      "description": "A string related to the application id."
    },
    "isConfidential": {
      "type": "boolean",
      "description": "A boolean related to the confidential status."
    },
    "trafficSourceList": {
      "type": "array",
      "description": "Array of traffic sources for this activity.",
      "items": {
        "type": "object",
        "properties": {
          "sourceShortName": {
            "type": "string",
            "description": "A string related to the source short name."
          },
          "sourceFullname": {
            "type": "string",
            "description": "A string related to the source full name."
          },
          "referralType": {
            "type": "string",
            "description": "A string related to the referral type."
          },
          "createdDate": {
            "type": "number",
            "nullable": true,
            "description": "A number related to the created date."
          },
          "activityTypes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "An array related to the activity types."
          },
          "utmMedium": {
            "type": "string",
            "nullable": true,
            "description": "A string related to the UTM medium."
          },
          "utmCampaign": {
            "type": "string",
            "nullable": true,
            "description": "A string related to the UTM campaign."
          }
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for assigning candidates to a job.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Data object for additional information related to the assignment of candidates to a job."
    },
    "message": {
      "type": "string",
      "description": "A message related to the assignment of candidates to the job."
    },
    "status": {
      "type": "string",
      "description": "The overall status of the assignment process."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for additional fields, typically related to job-specific information.",
  "properties": {
    "data": {
      "type": "object",
      "description": "Data object for additional fields information.",
      "properties": {
        "jobSpecificAdditionalFields": {
          "type": "object",
          "description": "Additional fields specific to a job."
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A message related to the additional fields."
    },
    "status": {
      "type": "string",
      "description": "The overall status of the additional fields response."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for hiring status activities, including pagination details and activity data.",
  "properties": {
    "pagination": {
      "type": "object",
      "description": "Pagination details for the hiring status activities.",
      "properties": {
        "size": {
          "type": "number",
          "description": "Number of items per page."
        },
        "from": {
          "type": "number",
          "description": "Starting index of the items in the current page."
        },
        "totalCount": {
          "type": "number",
          "description": "Total count of hiring status activities across all pages."
        }
      }
    },
    "data": {
      "type": "array",
      "description": "Array of hiring status activity data.",
      "items": {
        "type": "object",
        "description": "Details of a hiring status activity.",
        "properties": {
          "recruitersUserId": {
            "type": "string",
            "description": "User ID of the recruiter associated with the activity."
          },
          "recruiterName": {
            "type": "string",
            "description": "Name of the recruiter associated with the activity."
          },
          "candidateId": {
            "type": "string",
            "description": "ID of the candidate associated with the activity."
          },
          "actionType": {
            "type": "string",
            "description": "Type of action performed in the activity."
          },
          "createdDate": {
            "type": "number",
            "description": "Date when the activity was created."
          },
          "requestSource": {
            "type": "string",
            "description": "Source of the activity request."
          },
          "additionalFieldName": {
            "type": "string",
            "description": "Name of the additional field associated with the activity."
          },
          "previousValue": {
            "type": "string",
            "description": "Previous value of the additional field."
          },
          "updatedValue": {
            "type": "string",
            "description": "Updated value of the additional field."
          },
          "actionValue": {
            "type": "string",
            "description": "Value associated with the action."
          },
          "subject": {
            "type": "string",
            "description": "Subject of the activity."
          },
          "content": {
            "type": "string",
            "description": "Content of the activity."
          },
          "categoryName": {
            "type": "string",
            "description": "Name of the category associated with the activity."
          },
          "emailResponse": {
            "type": "string",
            "description": "Email response associated with the activity."
          },
          "fromEmail": {
            "type": "string",
            "description": "Email address from which the activity originated."
          },
          "fromName": {
            "type": "string",
            "description": "Name associated with the sender of the activity."
          },
          "toEmail": {
            "type": "string",
            "description": "Email address of the recipient of the activity."
          },
          "toName": {
            "type": "string",
            "description": "Name of the recipient of the activity."
          },
          "recipeName": {
            "type": "string",
            "description": "Name of the recipe associated with the activity."
          },
          "addedNewValue": {
            "type": "string",
            "description": "New value added in the activity."
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A message related to the hiring status activities."
    },
    "status": {
      "type": "string",
      "description": "The overall status of the hiring status activities response."
    },
    "timestamp": {
      "type": "string",
      "description": "Timestamp indicating when the response was generated."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object for job activities, including pagination details and job data.",
  "properties": {
    "status": {
      "type": "string",
      "description": "The overall status of the job activities response."
    },
    "message": {
      "type": "string",
      "description": "A message related to the job activities."
    },
    "timestamp": {
      "type": "string",
      "description": "Timestamp indicating when the response was generated."
    },
    "pagination": {
      "type": "object",
      "description": "Pagination details for the job activities.",
      "properties": {
        "size": {
          "type": "integer",
          "description": "Number of items per page."
        },
        "from": {
          "type": "integer",
          "description": "Starting index of the items in the current page."
        },
        "totalCount": {
          "type": "integer",
          "description": "Total count of job activities across all pages."
        }
      }
    },
    "data": {
      "type": "array",
      "description": "Array of job activity data.",
      "items": {
        "type": "object",
        "description": "Details of a job activity.",
        "properties": {
          "jobCategory": {
            "type": "string",
            "description": "Category of the job associated with the activity."
          },
          "jobTitle": {
            "type": "string",
            "description": "Title of the job associated with the activity."
          },
          "siteType": {
            "type": "string",
            "description": "Type of site associated with the job."
          },
          "trafficSourceList": {
            "type": "array",
            "description": "List of traffic sources associated with the job.",
            "items": {
              "type": "object",
              "properties": {
                "sourceShortName": {
                  "type": "string",
                  "description": "Short name of the traffic source."
                },
                "sourceFullname": {
                  "type": "string",
                  "description": "Full name of the traffic source."
                },
                "referralType": {
                  "type": "string",
                  "description": "Type of referral from the traffic source."
                },
                "createdDate": {
                  "type": "string",
                  "description": "Date when the traffic source was created."
                },
                "rawUrl": {
                  "type": "string",
                  "description": "Raw URL associated with the traffic source."
                }
              }
            }
          },
          "jobLocation": {
            "type": "string",
            "description": "Location of the job."
          },
          "updatedDate": {
            "type": "string",
            "description": "Date when the job activity was last updated."
          },
          "fieldID": {
            "type": "string",
            "description": "ID of the field associated with the job."
          },
          "locale": {
            "type": "string",
            "description": "Locale information associated with the job."
          },
          "jobId": {
            "type": "string",
            "description": "ID of the job associated with the activity."
          },
          "actionType": {
            "type": "string",
            "description": "Type of action performed in the activity."
          },
          "isConfidential": {
            "type": "string",
            "description": "Indicates whether the job is confidential."
          },
          "createdDate": {
            "type": "string",
            "description": "Date when the job activity was created."
          },
          "trafficSources": {
            "type": "array",
            "description": "List of traffic sources associated with the job activity.",
            "items": {
              "type": "object",
              "properties": {
                "sourceShortName": {
                  "type": "string",
                  "description": "Short name of the traffic source."
                },
                "sourceFullname": {
                  "type": "string",
                  "description": "Full name of the traffic source."
                },
                "referralType": {
                  "type": "string",
                  "description": "Type of referral from the traffic source."
                },
                "createdDate": {
                  "type": "string",
                  "description": "Date when the traffic source was created."
                },
                "rawUrl": {
                  "type": "string",
                  "description": "Raw URL associated with the traffic source."
                }
              }
            }
          }
        }
      }
    }
  }
}

copied!
{
  "type": "object",
  "description": "Response object indicating no content, typically used for successful requests with no additional data or message."
}

copied!
{
  "type": "object",
  "description": "Details about the source of traffic or referral.",
  "properties": {
    "sourceShortName": {
      "type": "string",
      "description": "A string related to the source short name."
    },
    "sourceFullname": {
      "type": "string",
      "description": "A string related to the source full name."
    },
    "referralType": {
      "type": "string",
      "description": "A string related to the referral type."
    },
    "createdDate": {
      "type": "number",
      "description": "A number related to the created date."
    },
    "activityTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array related to the activity types."
    },
    "utmMedium": {
      "type": "string",
      "description": "A string related to the UTM medium."
    },
    "utmCampaign": {
      "type": "string",
      "description": "A string related to the UTM campaign."
    }
  }
}

copied!
{
  "type": "object",
  "description": "Detailed information regarding the current hiring status and workflow step.",
  "properties": {
    "value": {
      "type": "string",
      "description": "A string related to the value of the hiring status."
    },
    "step": {
      "type": "string",
      "description": "A string related to the step value of the hiring status."
    },
    "hiringStatusCode": {
      "type": "string",
      "description": "A string related to the code of the hiring status value."
    },
    "hiringStepCode": {
      "type": "string",
      "description": "A string related to the value of the hiring status step."
    },
    "disposition": {
      "type": "string",
      "description": "A string related to the disposition of the hiring status."
    },
    "previousValue": {
      "type": "string",
      "description": "A string related to the previous value of the hiring status."
    },
    "previousStep": {
      "type": "string",
      "description": "A string related to the step value of the hiring status."
    },
    "updatedDate": {
      "type": "number",
      "description": "A number related to the updated date of the hiring status."
    },
    "workFlowStepId": {
      "type": "string",
      "description": "A string related to the work flow step id of the hiring status."
    },
    "hsPriority": {
      "type": "number",
      "description": "A string related to the hiring status priority."
    },
    "previousWorkFlowStepId": {
      "type": "string",
      "description": "A string related to the previous work flow step id of the hiring status."
    },
    "rejectionReason": {
      "type": "string",
      "description": "A string related to the rejection reason."
    },
    "rejectionReasonId": {
      "type": "string",
      "description": "A string related to the rejection reason id."
    },
    "previousHiringStatusCode": {
      "type": "string",
      "description": "A string related to the previous hiring status code."
    },
    "previousHiringStepCode": {
      "type": "string",
      "description": "A string related to the previous hiring status step code."
    },
    "previousRejectionReason": {
      "type": "string",
      "description": "A string related to the previous rejection reason."
    },
    "previousRejectionReasonId": {
      "type": "string",
      "description": "A string related to the previous rejection reason id."
    },
    "isRejected": {
      "type": "boolean",
      "description": "A boolean related to the rejection status."
    }
  }
}