How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
HeyMilo

HeyMilo Candidates API

Ingest candidates into an interviewer's workflow (sync or async, single or bulk) and list candidates with their progress.

Documentation Provider Profile APIs.io OpenAPI GitHub

HeyMilo Candidates API is one of 18 APIs that HeyMilo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Candidates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 5 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.heymilo.ai.

5 operations 4 paths 23 schemas 1 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.heymilo.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HeyMilo Candidates API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

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

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Candidates 5

Ingest candidates into an interviewer's workflow (sync or async, single or bulk) and list candidates with their progress.

POST
/api/v2/postings/{posting_id}/candidates
Ingest a single candidate
ingestCandidate 4 params body → 201401404429422
GET
/api/v2/postings/{posting_id}/candidates
List candidates for an interviewer
listCandidates 8 params → 200401404429400422
POST
/api/v2/postings/{posting_id}/candidates/bulk
Bulk ingest candidates
ingestCandidatesBulk 4 params body → 201401404429422
POST
/api/v2/postings/{posting_id}/candidates/async
Async ingest a single candidate
ingestCandidateAsync 4 params body → 202401404429422
POST
/api/v2/postings/{posting_id}/candidates/bulk/async
Async bulk ingest candidates
ingestCandidatesBulkAsync 4 params body → 202401404429422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are CandidateResponse (17 properties), WorkflowStepStatus (7 properties), APIError (6 properties), CandidateIngestRequest (5 properties). Each schema is shown below with its type and property counts.

IngestCandidateResponse
object
Response after successfully ingesting a candidate.
5 properties 3 required
SingleResponse_IngestCandidateResponse_
object
2 properties 1 required
PaginationMeta
object
3 properties 1 required
HTTPValidationError
object
1 property
CandidateWorkflow
object
Overall workflow progress for a candidate.
3 properties 2 required
APIError
object
6 properties 3 required
ValidationError
object
3 properties 3 required
BulkIngestCandidateResponseItem
object
A single item in the bulk ingest response.
4 properties 2 required
ListResponse_CandidateResponse_
object
2 properties 2 required
AgentSMSSummary
object
SMS screening summary metrics.
4 properties
AsyncIngestResponse
object
Response after queuing an async ingest job.
3 properties 1 required
WorkflowStepStatus
object
Status of a single workflow step for a candidate.
7 properties 5 required
BulkCandidateIngestRequest
object
1 property 1 required
AgentSummary
object
Per-agent-type summary metrics for a candidate.
4 properties
AgentWebInterviewSummary
object
Web interview summary metrics.
4 properties
APIErrorDetail
object
3 properties 2 required
AgentResumeSummary
object
Resume screening summary metrics.
3 properties
AgentFormSummary
object
Form screening summary metrics.
4 properties
CandidateIngestRequest
object
5 properties 2 required
CandidateResponse
object
A candidate within a posting's pipeline. Each candidate has a unique interviewid (one per candidate-posting pair) and a candidateid (shared across postings wit…
17 properties 5 required
SingleResponse_AsyncIngestResponse_
object
2 properties 1 required
APIErrorResponse
object
1 property 1 required
SingleResponse_list_BulkIngestCandidateResponseItem__
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-candidates-api-openapi.yml Raw ↑

Other APIs HeyMilo publishes across the network.

HeyMilo ATS API
AE Profile APIs.io
HeyMilo Design Template Groups API
AE Profile APIs.io
HeyMilo Design Templates API
AE Profile APIs.io
HeyMilo Domains API
AE Profile APIs.io
HeyMilo Email Template Groups API
AE Profile APIs.io
HeyMilo Email Templates API
AE Profile APIs.io
HeyMilo Health API
AE Profile APIs.io
HeyMilo Interview Templates API
AE Profile APIs.io
HeyMilo Interviewers API
AE Profile APIs.io
HeyMilo Interviews API
AE Profile APIs.io
HeyMilo Phone Numbers API
AE Profile APIs.io
HeyMilo Questions API
AE Profile APIs.io
#Candidates
← Back to H APIs
API Details
ID
heymilo:heymilo-candidates-api
Base URL
https://api.heymilo.ai
Docs
https://docs.heymilo.ai/api-reference/public-api/documentation
Provider
HeyMilo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=heymilo-candidates-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/heymilo-candidates-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of HeyMilo Candidates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.