Skip to main content
GET
/
api
/
v2
/
postings
/
{posting_id}
/
candidates
List candidates for an interviewer
curl --request GET \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/candidates \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "interview_id": "<string>",
      "posting_id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "status": "<string>",
      "object": "candidate",
      "candidate_id": "cand_def456",
      "score": 78.5,
      "interview_url": "https://candidates.heymilo.io/acme/i/D536A69A4090E13F",
      "workflow": {
        "steps": [
          {
            "step_id": "<string>",
            "order": 123,
            "status": "<string>",
            "started": true,
            "completed": true,
            "knocked_out": false,
            "last_updated_at": 1739713800
          }
        ],
        "all_complete": true,
        "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

​
X-API-KEY
string
required

Path Parameters

​
posting_id
string
required

Query Parameters

​
limit
integer
default:20

Maximum number of candidates to return (1–100).

Required range: 1 <= x <= 100
​
starting_after
string | null

Cursor for pagination. Pass the interview_id of the last candidate from the previous page.

​
created_after
string<date-time> | null

Only return candidates invited to this interviewer at or after this timestamp (inclusive). Accepts ISO-8601 datetimes such as 2026-03-13T00:00:00Z or 2026-03-13T00:00:00+00:00. Naive values (no offset) are interpreted as UTC. Combine with created_before to query a closed interval.

Example:

"2026-03-13T00:00:00Z"

​
created_before
string<date-time> | null

Only return candidates invited to this interviewer at or before this timestamp (inclusive). Accepts ISO-8601 datetimes such as 2026-03-14T23:59:59Z. Naive values (no offset) are interpreted as UTC.

Example:

"2026-03-14T23:59:59Z"

Response

Successful Response

​
data
CandidateResponse · object[]
required
​
pagination
PaginationMeta · object
required