Run status, progress, notices and candidates
curl --request GET \
--url https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id} \
--header 'x-partner-key: <api-key>' \
--header 'x-vort-org: <api-key>'const options = {
method: 'GET',
headers: {'x-partner-key': '<api-key>', 'x-vort-org': '<api-key>'}
};
fetch('https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id}"
headers = {
"x-partner-key": "<api-key>",
"x-vort-org": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-partner-key: <api-key>",
"x-vort-org: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"run_id": "9f2b6c1e-3d4a-4e8f-b1c7-0a5d2e9f6b33",
"status": "running",
"progress": {
"confirmed": 7,
"target": 30,
"screened": 184
},
"notices": [
{
"code": "location_relaxed",
"severity": "warning",
"slot": "above_list",
"title": "Search widened beyond Tel Aviv",
"body": "Not enough candidates were found in Tel Aviv, so candidates from outside the area are shown as well."
},
{
"code": "requirement_attribution",
"severity": "info",
"slot": "on_requirement",
"title": "Rejected because of this requirement",
"body": "41 candidates were rejected because of this requirement.",
"ref": {
"requirement_index": 1
}
}
],
"candidates": [
{
"id": 48213377,
"name": "Yael Cohen",
"title": "Staff Backend Engineer",
"company": "Northwind Payments",
"location": "Ramat Gan, Israel",
"verdict": "strong",
"requirements": [
{
"index": 0,
"text": "5+ years of backend development in Go or Java",
"kind": "must",
"met": true,
"evidence": "Backend engineer since 2017; Go at Northwind Payments (2021 to present)."
},
{
"index": 1,
"text": "Production experience with Kafka",
"kind": "must",
"met": true,
"evidence": "Led migration of the ledger pipeline to Kafka."
},
{
"index": 2,
"text": "Payments or fintech domain",
"kind": "nice",
"met": null,
"evidence": null
}
],
"contact_state": "locked",
"reveal_price_credits": 15
}
]
}{
"error": "invalid_org_token",
"message": "The organization token is not valid."
}{
"error": "organization_disabled",
"message": "This organization's Vort connection is disabled."
}{
"error": "invalid_partner_key",
"message": "<string>"
}{
"error": "rate_limited",
"message": "Too many requests."
}{
"error": "rate_limit_unavailable",
"message": "Rate limiting is temporarily unavailable. Retry shortly."
}Authorizations
Partner API key: vpk_live_ + 48 lowercase hex. Server-side only.
Customer org token: vot_ + 48 lowercase hex, from /activations/redeem. Server-side only.
Headers
Language of notices and messages. Defaults to the partner default.
he, en Path Parameters
Response
The run.
Treat any other value as running.
"running"
"completed"
"failed"
Hide child attributes
Hide child attributes
Stable identifier; see Notices. New codes appear without notice.
"requirement_blockers"
"widen_hint"
"already_shown"
"relaxation_ladder"
"location_relaxed"
"global_relaxed"
"paid_fallback"
"lean_search_failed"
"requirement_attribution"
"run_funnel"
"run_progress"
"function_error"
Known values: info, warning, blocking.
"info"
"warning"
"blocking"
Known values: above_list, on_candidate, on_requirement, empty_state.
"above_list"
"on_candidate"
"on_requirement"
"empty_state"
Confirmed candidates in Vort's display order.
Hide child attributes
Hide child attributes
strong, good, weak Hide child attributes
Hide child attributes
x >= 0must, nice null = could not be determined from the profile.
locked, revealed Price at the time of this response. Never hard-code.
x >= 0curl --request GET \
--url https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id} \
--header 'x-partner-key: <api-key>' \
--header 'x-vort-org: <api-key>'const options = {
method: 'GET',
headers: {'x-partner-key': '<api-key>', 'x-vort-org': '<api-key>'}
};
fetch('https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id}"
headers = {
"x-partner-key": "<api-key>",
"x-vort-org": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vort-partner-api.vercel.app/sandbox/v1/runs/{run_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-partner-key: <api-key>",
"x-vort-org: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"run_id": "9f2b6c1e-3d4a-4e8f-b1c7-0a5d2e9f6b33",
"status": "running",
"progress": {
"confirmed": 7,
"target": 30,
"screened": 184
},
"notices": [
{
"code": "location_relaxed",
"severity": "warning",
"slot": "above_list",
"title": "Search widened beyond Tel Aviv",
"body": "Not enough candidates were found in Tel Aviv, so candidates from outside the area are shown as well."
},
{
"code": "requirement_attribution",
"severity": "info",
"slot": "on_requirement",
"title": "Rejected because of this requirement",
"body": "41 candidates were rejected because of this requirement.",
"ref": {
"requirement_index": 1
}
}
],
"candidates": [
{
"id": 48213377,
"name": "Yael Cohen",
"title": "Staff Backend Engineer",
"company": "Northwind Payments",
"location": "Ramat Gan, Israel",
"verdict": "strong",
"requirements": [
{
"index": 0,
"text": "5+ years of backend development in Go or Java",
"kind": "must",
"met": true,
"evidence": "Backend engineer since 2017; Go at Northwind Payments (2021 to present)."
},
{
"index": 1,
"text": "Production experience with Kafka",
"kind": "must",
"met": true,
"evidence": "Led migration of the ledger pipeline to Kafka."
},
{
"index": 2,
"text": "Payments or fintech domain",
"kind": "nice",
"met": null,
"evidence": null
}
],
"contact_state": "locked",
"reveal_price_credits": 15
}
]
}{
"error": "invalid_org_token",
"message": "The organization token is not valid."
}{
"error": "organization_disabled",
"message": "This organization's Vort connection is disabled."
}{
"error": "invalid_partner_key",
"message": "<string>"
}{
"error": "rate_limited",
"message": "Too many requests."
}{
"error": "rate_limit_unavailable",
"message": "Rate limiting is temporarily unavailable. Retry shortly."
}