---
updatedAt: 2025-10-16T12:15:26.000Z
agentTools:
  projectIndex: https://clayhr.readme.io/llms.txt
---

# Retrieve the candidate detail by recruitid

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Candidates",
    "version": "1.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://acmecompany.clayhr.com/rm/api/v3/candidate"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/detail/{recruitid}": {
      "get": {
        "tags": [
          "Candidates"
        ],
        "summary": "Retrieve the candidate detail by recruitid",
        "description": "",
        "operationId": "retrieve-the-candidate-detail-by-recruitid",
        "parameters": [
          {
            "name": "recruitid",
            "in": "path",
            "description": "The ID of the recruiter.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          },
          {
            "name": "userid",
            "in": "header",
            "description": "The ID of the user to authenticate.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "description": "The API key of the user to authenticate.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"data\": {\n    \"recruitId\": \"int\",\n    \"name\": \"string\",\n    \"referrerId\": \"int\",\n    \"referrer\": \"string\",\n    \"recruiter\": \"string\",\n    \"score\": \"string\",\n    \"updatedOn\": \"int\",\n    \"status\": \"string\",\n    \"notes\": \"string\",\n    \"dateOfBirth\": \"int\",\n    \"joiningDate\": \"int\",\n    \"cid\": \"int\",\n    \"email\": \"string\",\n    \"phone\": \"int\",\n    \"createts\": \"int\",\n    \"templateId\": \"int\",\n    \"recruiterUserId\": \"int\",\n    \"workflowId\": \"int\",\n    \"statusid\": \"int\",\n    \"workflowModel\": \"Model\",\n    \"candidateStatusModel\": \"Model\",\n    \"assessmentModel\": \"Model\",\n    \"workflowName\": \"string\",\n    \"employmentModelList\": \"ModelList\",\n    \"educationModelList\": \"ModelList\",\n    \"customFieldValueModelList\": \"ModelList\",\n    \"addressModelList\": \"ModelList\",\n    \"skillModelList\": \"ModelList\",\n    \"positionName\": \"string\",\n    \"candidatePositionsModelList\": \"ModelList\",\n    \"createuserid\": \"int\",\n    \"lastupdateuserid\": \"int\",\n    \"accessCode\": \"int\",\n    \"source\": \"int\",\n    \"passwordHash\": \"string\",\n    \"acceptance1\": \"string\",\n    \"acceptance2\": \"string\",\n    \"summaryByCandidate\": \"string\",\n    \"systemReco\": \"string\",\n    \"systemRecoHelp\": \"string\",\n    \"candidateLock\": \"int\",\n    \"salaryCurrencyCode\": \"int\",\n    \"salaryAmount\": \"int\",\n    \"educationStr\": \"string\",\n    \"languagePreference\": \"string\",\n    \"userId\": \"int\",\n    \"verified\": \"string\",\n    \"verificationCode\": \"int\",\n    \"isInternalCand\": \"string\",\n    \"isNewCand\": \"string\",\n    \"timezone\": \"string\",\n    \"trainingAccess\": \"string\",\n    \"customfieldvalue\": \"string\",\n    \"cloudSearchSync\": \"int\",\n    \"jobBoardAccess\": \"string\",\n    \"bgScreeningOrderGuid\": \"int\",\n    \"bgScreeningOrderCreateDate\": \"int\",\n    \"checkrCandidateId\": \"int\",\n    \"positionModel\": \"Model\",\n    \"certificationModelList\": \"ModelList\",\n    \"attachmentModelList\": \"ModelList\"\n  },\n  \"message\": \"successful\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "recruitId": {
                          "type": "string",
                          "example": "int"
                        },
                        "name": {
                          "type": "string",
                          "example": "string"
                        },
                        "referrerId": {
                          "type": "string",
                          "example": "int"
                        },
                        "referrer": {
                          "type": "string",
                          "example": "string"
                        },
                        "recruiter": {
                          "type": "string",
                          "example": "string"
                        },
                        "score": {
                          "type": "string",
                          "example": "string"
                        },
                        "updatedOn": {
                          "type": "string",
                          "example": "int"
                        },
                        "status": {
                          "type": "string",
                          "example": "string"
                        },
                        "notes": {
                          "type": "string",
                          "example": "string"
                        },
                        "dateOfBirth": {
                          "type": "string",
                          "example": "int"
                        },
                        "joiningDate": {
                          "type": "string",
                          "example": "int"
                        },
                        "cid": {
                          "type": "string",
                          "example": "int"
                        },
                        "email": {
                          "type": "string",
                          "example": "string"
                        },
                        "phone": {
                          "type": "string",
                          "example": "int"
                        },
                        "createts": {
                          "type": "string",
                          "example": "int"
                        },
                        "templateId": {
                          "type": "string",
                          "example": "int"
                        },
                        "recruiterUserId": {
                          "type": "string",
                          "example": "int"
                        },
                        "workflowId": {
                          "type": "string",
                          "example": "int"
                        },
                        "statusid": {
                          "type": "string",
                          "example": "int"
                        },
                        "workflowModel": {
                          "type": "string",
                          "example": "Model"
                        },
                        "candidateStatusModel": {
                          "type": "string",
                          "example": "Model"
                        },
                        "assessmentModel": {
                          "type": "string",
                          "example": "Model"
                        },
                        "workflowName": {
                          "type": "string",
                          "example": "string"
                        },
                        "employmentModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "educationModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "customFieldValueModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "addressModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "skillModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "positionName": {
                          "type": "string",
                          "example": "string"
                        },
                        "candidatePositionsModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "createuserid": {
                          "type": "string",
                          "example": "int"
                        },
                        "lastupdateuserid": {
                          "type": "string",
                          "example": "int"
                        },
                        "accessCode": {
                          "type": "string",
                          "example": "int"
                        },
                        "source": {
                          "type": "string",
                          "example": "int"
                        },
                        "passwordHash": {
                          "type": "string",
                          "example": "string"
                        },
                        "acceptance1": {
                          "type": "string",
                          "example": "string"
                        },
                        "acceptance2": {
                          "type": "string",
                          "example": "string"
                        },
                        "summaryByCandidate": {
                          "type": "string",
                          "example": "string"
                        },
                        "systemReco": {
                          "type": "string",
                          "example": "string"
                        },
                        "systemRecoHelp": {
                          "type": "string",
                          "example": "string"
                        },
                        "candidateLock": {
                          "type": "string",
                          "example": "int"
                        },
                        "salaryCurrencyCode": {
                          "type": "string",
                          "example": "int"
                        },
                        "salaryAmount": {
                          "type": "string",
                          "example": "int"
                        },
                        "educationStr": {
                          "type": "string",
                          "example": "string"
                        },
                        "languagePreference": {
                          "type": "string",
                          "example": "string"
                        },
                        "userId": {
                          "type": "string",
                          "example": "int"
                        },
                        "verified": {
                          "type": "string",
                          "example": "string"
                        },
                        "verificationCode": {
                          "type": "string",
                          "example": "int"
                        },
                        "isInternalCand": {
                          "type": "string",
                          "example": "string"
                        },
                        "isNewCand": {
                          "type": "string",
                          "example": "string"
                        },
                        "timezone": {
                          "type": "string",
                          "example": "string"
                        },
                        "trainingAccess": {
                          "type": "string",
                          "example": "string"
                        },
                        "customfieldvalue": {
                          "type": "string",
                          "example": "string"
                        },
                        "cloudSearchSync": {
                          "type": "string",
                          "example": "int"
                        },
                        "jobBoardAccess": {
                          "type": "string",
                          "example": "string"
                        },
                        "bgScreeningOrderGuid": {
                          "type": "string",
                          "example": "int"
                        },
                        "bgScreeningOrderCreateDate": {
                          "type": "string",
                          "example": "int"
                        },
                        "checkrCandidateId": {
                          "type": "string",
                          "example": "int"
                        },
                        "positionModel": {
                          "type": "string",
                          "example": "Model"
                        },
                        "certificationModelList": {
                          "type": "string",
                          "example": "ModelList"
                        },
                        "attachmentModelList": {
                          "type": "string",
                          "example": "ModelList"
                        }
                      }
                    },
                    "message": {
                      "type": "string",
                      "example": "successful"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"not found\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "not found"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "409",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"failure\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "failure"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "x-readme-fauxas": true
}
```