post https://sandbox.newcraft.io/jobs//candidates/get
Retrieves all the candidates who have applied for a job.
Response Definitions
| Response Item | Description | Data type |
|---|---|---|
| id | The ID associated with the candidate. Each candidate ID is assigned by NewCraft. | String |
| {attributes}/id | The ID associated with the candidate. Each candidate ID is assigned by NewCraft. | String |
| {attributes}/address | The address of the candidate. | String |
| {attributes}/first_name | The first name of the candidate. | String |
| {attributes}/last_name | The last name of the candidate. | String |
| {attributes}/email | The candidate's email address. | String |
| {attributes}/email_type | Describes type of email address on file for the candidate; particularly, whether it is professional or personal. | String |
| {attributes}/job_id | The ID associated with the job the candidate applied for. Each job ID is assigned by NewCraft, and can be used to access more specific information regarding the job through the Jobs endpoint. | String |
| {attributes}/phone_number_type | Describes the type of phone number on file for the candidate; particularly, if it is a mobile, home, or work phone number. | String |
| {attributes}/phone_number | The candidate's phone number. This includes the area code, making for a 10-digit number in the format "XXX-XXX-XXXX". | String |
| {attributes}/status | The status of the candidate. "applied" means that the candidate has applied for the job and not yet been interviewed, "interviewed" means that the candidate has been interviewed and is awaiting a hiring decision, "hired" means that the candidate has been hired. | String |
Sample Response
{
"data": [
{
"id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
"type": "Candidate",
"attributes": {
"id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
"address": "226 St. James Pl, Brooklyn, NY 11238",
"first_name": "Kimberly",
"last_name": "Jones",
"email": "[email protected]",
"email_type": "work",
"job_id": "012c7540-e319-46c7-b387-e06b352cc54f",
"phone_number_type": "mobile",
"phone_number": "123-444-5678"
"status": "applied"
}
},
{
"id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
"type": "Candidate",
"attributes": {
"id": "cf778177-84f5-4401-a388-c5b1ee0221e8",
"address": "226 St. James Pl, Brooklyn, NY 11238",
"first_name": "Kimberly",
"last_name": "Jones",
"email": "[email protected]",
"email_type": "work",
"job_id": "012c7540-e319-46c7-b387-e06b352cc54f",
"phone_number_type": "mobile",
"phone_number": "123-444-5678"
"status": "applied"
}
}
]
}
}