HeyMilo Candidates API
Ingest candidates into an interviewer's workflow (sync or async, single or bulk) and list candidates with their progress.
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.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.heymilo.ai.
Metadata
The identity and technical contract details declared by the specification.
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.
Ingest candidates into an interviewer's workflow (sync or async, single or bulk) and list candidates with their progress.
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), IngestCandidateResponse (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HeyMilo 12
Other APIs HeyMilo publishes across the network.