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 Questions API

Create, read, update, delete, and reorder questions and criteria for an interviewer's workflow. Covers all modalities: voice, sms, form, resume_eligibility, resume_scoring, and voice_tags.

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

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

This API exposes 6 operations across 3 paths, and defines 12 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.

6 operations 3 paths 12 schemas 1 DELETE2 GET1 PATCH2 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 Questions 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 6

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

Questions 6

Create, read, update, delete, and reorder questions and criteria for an interviewer's workflow. Covers all modalities: voice, sms, form, resumeeligibility, resumescoring, and voic…

GET
/api/v2/postings/{posting_id}/questions
List questions
listQuestions 7 params → 200401404429422
POST
/api/v2/postings/{posting_id}/questions
Create a question
createQuestion 4 params body → 201401404429422
GET
/api/v2/postings/{posting_id}/questions/{question_id}
Retrieve a question
getQuestion 5 params → 200401404429422
PATCH
/api/v2/postings/{posting_id}/questions/{question_id}
Update a question
updateQuestion 5 params body → 200401404429422
DELETE
/api/v2/postings/{posting_id}/questions/{question_id}
Delete a question
deleteQuestion 5 params → 200401404429422
POST
/api/v2/postings/{posting_id}/questions/reorder
Reorder questions
reorderQuestions 4 params body → 200401404429422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are QuestionResponse (36 properties), CreateQuestionRequest (30 properties), UpdateQuestionRequest (29 properties), APIError (6 properties). Each schema is shown below with its type and property counts.

APIErrorDetail
object
3 properties 2 required
UpdateQuestionRequest
object
Request body for updating a question. Only provided fields are modified; omitted fields remain unchanged.
29 properties
PaginationMeta
object
3 properties 1 required
QuestionResponse
object
A question or criterion belonging to a posting. The modality field indicates the question type (voice, sms, form, resumeeligibility, resumescoring, voicetags).…
36 properties 4 required
SingleResponse_QuestionResponse_
object
2 properties 1 required
APIError
object
6 properties 3 required
ValidationError
object
3 properties 3 required
ReorderQuestionsRequest
object
Request body for reordering questions within a modality.
2 properties 2 required
APIErrorResponse
object
1 property 1 required
ListResponse_QuestionResponse_
object
2 properties 2 required
HTTPValidationError
object
1 property
CreateQuestionRequest
object
Request body for creating a new question or criterion. The modality field determines the question type. Only fields relevant to the chosen modality need to be…
30 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-questions-api-openapi.yml Raw ↑

Other APIs HeyMilo publishes across the network.

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