Getting Started
Endpoints
- Applications
- Candidates
- Jobs
- Feedback
- Interviews
- Users
- Files
- Settings
- Webhooks
Webhooks
Create interview
Create an interview
curl --request POST \
--url https://api.hirehive.com/v1.0/{company_id}/interviews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"application_id": "<string>",
"event": {
"title": "<string>",
"location": "<string>",
"type": "phone",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"time_zone": "<string>",
"organizer_id": "<string>",
"attendees": [
{
"application_id": "<string>",
"user_id": "<string>",
"type": "user",
"email": "<string>"
}
]
},
"meta": {
"note_for_candidate": "<string>",
"note_for_attendees": "<string>",
"attach_resume_to_invite": true,
"online_meeting_type": "hangouts_meet",
"meeting_url": "<string>"
}
}'{
"data": {
"id": "<string>",
"candidate_id": "<string>",
"application_id": "<string>",
"job_id": "<string>",
"event": {
"title": "<string>",
"location": "<string>",
"type": "phone",
"status": "active",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"time_zone": "<string>",
"organizer_id": "<string>",
"attendees": [
{
"id": "<string>",
"application_id": "<string>",
"user_id": "<string>",
"type": "user",
"status": "accepted",
"display_name": "<string>",
"email": "<string>"
}
]
},
"meta": {
"note_for_candidate": "<string>",
"note_for_attendees": "<string>",
"attach_resume_to_invite": true,
"online_meeting_type": "hangouts_meet",
"meeting_url": "<string>"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
The id of the application who the interview is for.
The title of the event.
The address of the interview if onsite.
phone, online, on_site The datetime the interview starts at
The datetime the interview ends at
The timezone of the interview start and end date
The user id of the organiser
The list of attendees for this interview
The id of the application if the attendee is the candidate
The user id of the attendee if they are a user
user, candidate, guest The email address if they are an external guest
hangouts_meet, event_named_hangout, event_hangout, unknown, skype_for_consumer, skype_for_business, teams_for_business The online link to the meeting if any.
Response
The id of the interview. Format int_1a2b3c
The id of the candidate. Format can_1a2b3c
The id of the application. Format app_1a2b3c
The id of the job. Format job_1a2b3c
The title of the event.
The address of the interview if onsite.
phone, online, on_site active, past, cancelled The datetime the interview starts at
The datetime the interview ends at
The timezone of the interview start and end date
The user id of the organiser
The list of attendees for this interview
The id of the interview. Format attd_1a2b3c
The id of the application if the attendee is the candidate. Format app_1a2b3c
The user id of the attendee if they are a user. Format usr_1a2b3c
user, candidate, guest accepted, pending, maybe, declined hangouts_meet, event_named_hangout, event_hangout, unknown, skype_for_consumer, skype_for_business, teams_for_business Was this page helpful?
curl --request POST \
--url https://api.hirehive.com/v1.0/{company_id}/interviews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"application_id": "<string>",
"event": {
"title": "<string>",
"location": "<string>",
"type": "phone",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"time_zone": "<string>",
"organizer_id": "<string>",
"attendees": [
{
"application_id": "<string>",
"user_id": "<string>",
"type": "user",
"email": "<string>"
}
]
},
"meta": {
"note_for_candidate": "<string>",
"note_for_attendees": "<string>",
"attach_resume_to_invite": true,
"online_meeting_type": "hangouts_meet",
"meeting_url": "<string>"
}
}'{
"data": {
"id": "<string>",
"candidate_id": "<string>",
"application_id": "<string>",
"job_id": "<string>",
"event": {
"title": "<string>",
"location": "<string>",
"type": "phone",
"status": "active",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"time_zone": "<string>",
"organizer_id": "<string>",
"attendees": [
{
"id": "<string>",
"application_id": "<string>",
"user_id": "<string>",
"type": "user",
"status": "accepted",
"display_name": "<string>",
"email": "<string>"
}
]
},
"meta": {
"note_for_candidate": "<string>",
"note_for_attendees": "<string>",
"attach_resume_to_invite": true,
"online_meeting_type": "hangouts_meet",
"meeting_url": "<string>"
}
}
}