cURL
curl --request POST \
--url https://api.alpharun.com/api/v1/interviews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
],
"interview_custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
'import requests
url = "https://api.alpharun.com/api/v1/interviews"
payload = [
{
"job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
],
"interview_custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
job_opening_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
email: '[email protected]',
first_name: '<string>',
last_name: '<string>',
phone_number: '<string>',
custom_fields: [{key: '<string>', value: '<string>'}],
interview_custom_fields: [{key: '<string>', value: '<string>'}]
}
])
};
fetch('https://api.alpharun.com/api/v1/interviews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alpharun.com/api/v1/interviews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'job_opening_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'email' => '[email protected]',
'first_name' => '<string>',
'last_name' => '<string>',
'phone_number' => '<string>',
'custom_fields' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'interview_custom_fields' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alpharun.com/api/v1/interviews"
payload := strings.NewReader("[\n {\n \"job_opening_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"[email protected]\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"interview_custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.alpharun.com/api/v1/interviews")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"job_opening_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"[email protected]\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"interview_custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpharun.com/api/v1/interviews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"job_opening_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"[email protected]\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"interview_custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"successful_imports_count": 123,
"failed_imports_count": 123,
"failed_contacts": [
{
"job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"resume": {
"content": "<string>",
"mimetype": "<string>"
},
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
],
"interview_custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
}{
"error": 123,
"message": "<string>"
}Hiring
Add Candidates to Job Openings
Invite candidates to take the interview for provided job openings (e.g. after reviewing their profile in an ATS).
Please note that passing a resume is only possible if only a single contact is passed in the request body.
POST
/
interviews
cURL
curl --request POST \
--url https://api.alpharun.com/api/v1/interviews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
],
"interview_custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
'import requests
url = "https://api.alpharun.com/api/v1/interviews"
payload = [
{
"job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
],
"interview_custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
job_opening_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
email: '[email protected]',
first_name: '<string>',
last_name: '<string>',
phone_number: '<string>',
custom_fields: [{key: '<string>', value: '<string>'}],
interview_custom_fields: [{key: '<string>', value: '<string>'}]
}
])
};
fetch('https://api.alpharun.com/api/v1/interviews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alpharun.com/api/v1/interviews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'job_opening_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'email' => '[email protected]',
'first_name' => '<string>',
'last_name' => '<string>',
'phone_number' => '<string>',
'custom_fields' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'interview_custom_fields' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alpharun.com/api/v1/interviews"
payload := strings.NewReader("[\n {\n \"job_opening_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"[email protected]\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"interview_custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.alpharun.com/api/v1/interviews")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"job_opening_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"[email protected]\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"interview_custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpharun.com/api/v1/interviews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"job_opening_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"email\": \"[email protected]\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"interview_custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"successful_imports_count": 123,
"failed_imports_count": 123,
"failed_contacts": [
{
"job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"resume": {
"content": "<string>",
"mimetype": "<string>"
},
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
],
"interview_custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
}{
"error": 123,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Array of candidates to add to the job opening
Minimum array length:
1- Option 1
- Option 2
ID of the job opening to add contacts to
Email address of the contact
First name of the contact
Last name of the contact
Phone number of the contact
Resume of the contact.
Show child attributes
Show child attributes
Custom fields to populate on the contact
Show child attributes
Show child attributes
Custom fields to populate on the interview
Show child attributes
Show child attributes
⌘I