Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HeyMilo ATS API

The ATS API from HeyMilo — 4 operation(s) for ats.

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

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

This API exposes 4 operations across 4 paths, and defines 18 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.

4 operations 4 paths 18 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

HeyMilo ATS 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 4

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

ATS 4
POST
/api/v2/ats/candidates/resolve
Resolve a candidate in the ATS
resolveAtsCandidate 3 params body → 200400401429422
POST
/api/v2/ats/candidates/push
Push a candidate to the ATS
pushAtsCandidate 3 params body → 200400401429422
GET
/api/v2/ats/candidates/push/{item_id}
Get push status
getAtsPushStatus 4 params → 200400401429422
GET
/api/v2/ats/connections
List ATS connections
listAtsConnections 3 params → 200400401429422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are CandidateMatch (9 properties), QueueItemStatus (8 properties), AtsConnection (7 properties), ResolveCandidateResponse (6 properties). Each schema is shown below with its type and property counts.

APIErrorDetail
object
3 properties 2 required
SingleResponse_QueueItemStatus_
object
2 properties 1 required
PushCandidateRequest
object
6 properties 2 required
SingleResponse_EnqueuePushResponse_
object
2 properties 1 required
APIError
object
6 properties 3 required
ValidationError
object
3 properties 3 required
APIErrorResponse
object
1 property 1 required
SingleResponse_ResolveCandidateResponse_
object
2 properties 1 required
ResolveCandidateRequest
object
4 properties 1 required
ResolveCandidateResponse
object
6 properties 1 required
PushCandidatePayload
object
6 properties
QueueItemStatus
object
8 properties 2 required
CandidateMatch
object
9 properties
ListResponse_AtsConnection_
object
2 properties 2 required
AtsConnection
object
7 properties 2 required
EnqueuePushResponse
object
3 properties 1 required
HTTPValidationError
object
1 property
PaginationMeta
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-ats-api-openapi.yml Raw ↑

Other APIs HeyMilo publishes across the network.

HeyMilo Candidates API
HeyMilo Design Template Groups API
HeyMilo Design Templates API
HeyMilo Domains API
HeyMilo Email Template Groups API
HeyMilo Email Templates API
HeyMilo Health API
HeyMilo Interview Templates API
HeyMilo Interviewers API
HeyMilo Interviews API
HeyMilo Phone Numbers API
HeyMilo Questions API