curl --request GET \
--url https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates', 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.heymilo.ai/api/v2/postings/{posting_id}/candidates",
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-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"interview_id": "D536A69A4090E13F",
"posting_id": "13D77095",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"status": "completed",
"object": "candidate",
"candidate_id": "cand_def456",
"score": 78.5,
"interview_url": "https://candidates.heymilo.io/acme/i/D536A69A4090E13F",
"workflow": {
"steps": [
{
"step_id": "agent_vi_001",
"order": 1,
"status": "completed",
"started": true,
"completed": true,
"knocked_out": false,
"last_updated_at": 1739713800
}
],
"all_complete": false,
"last_activity_at": 1739715600
},
"agent_summary": {
"resume": {
"resume_score": 3.8,
"is_eligible": true,
"resume_link": "https://cdn.heymilo.io/resumes/abc123.pdf"
},
"web_interview": {
"score": 82,
"highlights": [
"<string>"
],
"audio_recording_link": "<string>",
"video_recording_link": "<string>"
},
"sms": {
"is_eligible": true,
"criteria_passed": [
"<string>"
],
"criteria_failed": [
"<string>"
],
"messages_sent": 8
},
"form": {
"is_complete": true,
"is_eligible": true,
"questions_answered": 5,
"total_questions": 7
}
},
"shortlisted": false,
"dismissed": false,
"metadata": {
"ats_stage": "phone_screen",
"external_id": "candidate_xyz"
},
"data": {},
"interviewed_at": 1739713800,
"created_at": 1739612400
}
],
"pagination": {
"has_more": true,
"total_count": 123,
"url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}List candidates for an interviewer
Retrieve a paginated list of candidates for a specific interviewer. Each candidate includes workflow progress, scores, and agent summaries.
curl --request GET \
--url https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates', 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.heymilo.ai/api/v2/postings/{posting_id}/candidates",
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-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"interview_id": "D536A69A4090E13F",
"posting_id": "13D77095",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"status": "completed",
"object": "candidate",
"candidate_id": "cand_def456",
"score": 78.5,
"interview_url": "https://candidates.heymilo.io/acme/i/D536A69A4090E13F",
"workflow": {
"steps": [
{
"step_id": "agent_vi_001",
"order": 1,
"status": "completed",
"started": true,
"completed": true,
"knocked_out": false,
"last_updated_at": 1739713800
}
],
"all_complete": false,
"last_activity_at": 1739715600
},
"agent_summary": {
"resume": {
"resume_score": 3.8,
"is_eligible": true,
"resume_link": "https://cdn.heymilo.io/resumes/abc123.pdf"
},
"web_interview": {
"score": 82,
"highlights": [
"<string>"
],
"audio_recording_link": "<string>",
"video_recording_link": "<string>"
},
"sms": {
"is_eligible": true,
"criteria_passed": [
"<string>"
],
"criteria_failed": [
"<string>"
],
"messages_sent": 8
},
"form": {
"is_complete": true,
"is_eligible": true,
"questions_answered": 5,
"total_questions": 7
}
},
"shortlisted": false,
"dismissed": false,
"metadata": {
"ats_stage": "phone_screen",
"external_id": "candidate_xyz"
},
"data": {},
"interviewed_at": 1739713800,
"created_at": 1739612400
}
],
"pagination": {
"has_more": true,
"total_count": 123,
"url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "The request body failed validation",
"param": "<string>",
"doc_url": "<string>",
"errors": [
{
"code": "invalid_param",
"message": "title must be between 3 and 200 characters",
"param": "title"
}
]
}
}Authorizations
API key for authentication. Pass your key in the X-API-KEY header.
Path Parameters
Query Parameters
Maximum number of candidates to return (1–100).
1 <= x <= 100Cursor for pagination. Pass the interview_id of the last candidate from the previous page.
Only return candidates invited to this interviewer at or after this bound (inclusive). Accepts an ISO-8601 datetime such as 2026-03-13T00:00:00Z or 2026-03-13T00:00:00+00:00, or Unix epoch seconds matching the created_at field in the response. Naive ISO values (no offset) are interpreted as UTC. Combine with created_before to query a closed interval.
"2026-03-13T00:00:00Z"
Only return candidates invited to this interviewer at or before this bound (inclusive). Accepts an ISO-8601 datetime such as 2026-03-14T23:59:59Z, or Unix epoch seconds matching the created_at field in the response. Naive ISO values (no offset) are interpreted as UTC.
"2026-03-14T23:59:59Z"
Was this page helpful?