Getting Started
Endpoints
- Applications
- Candidates
- Jobs
- Feedback
- Interviews
- Users
- Files
- Settings
- Webhooks
Webhooks
Application object
The current status of the application.
The parent stage of the application. eg Screening, Interviewing
rejected, new, screening, interviewing, offered, hired A list of any GDPR consent extensions requests.
The id of the application, format app_abc123.
The candidate object.
The first name of the candidate.
1The last name of the candidate.
1The id of the candidate, format can_abc123.
The full name of the candidate.
The email address of the candidate.
The phone number of the candidate.
The current job title of the candidate.
The current company of the candidate.
An image url to a profile picture
A 1-5 star rating assigned to the candidate.
A list of other application ids this candidate may have. Format app_abc123.
The date and time of the application in UTC.
The cover letter for this application
The origin of the application. eg Applied, Added, Submitted by an agency
added, applied, interested, referred, candidate_pool, hire_hive_import, agency_submission The source name. eg Google, LinkedIn
List of interview ids for this application
List of feedback forms ids for this application
Was this page helpful?
{
"id": "<string>",
"candidate": {
"id": "<string>",
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"title": "<string>",
"company": "<string>",
"location": {
"address": "<string>",
"country": {
"name": "<string>",
"code": "<string>"
}
},
"image_url": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"rating": 123,
"application_ids": [
"<string>"
],
"social_profiles": [
{
"type": "linked_in",
"uri": "<string>"
}
]
},
"applied_at": "2023-11-07T05:31:56Z",
"job": {
"id": "<string>",
"title": "<string>"
},
"cover_letter": "<string>",
"stage": {
"parent_stage": "rejected",
"custom_stage": {
"id": "<string>",
"name": "<string>"
}
},
"resume": {
"id": "<string>",
"original": {
"name": "<string>",
"original_name": "<string>",
"content_type": "<string>",
"file_extension": "<string>"
},
"pdf": {
"name": "<string>",
"original_name": "<string>",
"content_type": "<string>",
"file_extension": "<string>"
}
},
"source": {
"origin": "added",
"source": "<string>",
"contact": {
"id": "<string>",
"name": "<string>"
},
"user": {
"id": "<string>",
"name": "<string>"
},
"recruiter": {
"id": "<string>",
"name": "<string>"
}
},
"interviews": [
"<string>"
],
"feedback": [
"<string>"
],
"potential_duplicate": true,
"compliance": {
"gdpr": {
"consent_expires_at": "2023-11-07T05:31:56Z",
"consent_requests": [
{
"status": "pending",
"sent_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
]
}
}
}