Retrieve a question

Returns a single question or criterion by its ID.

GET /api/v2/postings/{posting_id}/questions/{question_id}

Retrieve a question

cURL

curl --request GET \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/questions/{question_id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "posting_id": "<string>",
    "modality": "<string>",
    "text": "<string>",
    "object": "question",
    "rank": 1,
    "evaluation_criteria": "<string>",
    "score_of_1": "<string>",
    "score_of_5": "<string>",
    "score_weight": 123,
    "not_scored": true,
    "question_type": "<string>",
    "min_follow_ups": 123,
    "max_follow_ups": 123,
    "additional_instructions": "<string>",
    "post_processing_evaluation_criteria": "<string>",
    "expected_answer": "<string>",
    "expected_value": 123,
    "is_dealbreaker": true,
    "answer": "<unknown>",
    "is_knockout": true,
    "dropdown_values": [
      {}
    ],
    "is_answer_mandated": true,
    "mcq_type": "<string>",
    "operator": "<string>",
    "file_types": [
      "<string>"
    ],
    "allow_multiple_files": true,
    "slider_min": 123,
    "slider_max": 123,
    "slider_step": 123,
    "instructions": "<string>",
    "options": [
      "<string>"
    ],
    "structured_config": {},
    "created_at": 123,
    "updated_at": 123
  },
  "meta": {}
}

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 | null

Authorization · string | null

X-Workspace-Id · string | null

Path Parameters

posting_id · string · required

question_id · string · required

Response

200

application/json

Successful Response

data · QuestionResponse · object · required

A question or criterion belonging to a posting.

The modality field indicates the question type (voice, sms, form, resume_eligibility, resume_scoring, voice_tags). Fields that are not applicable to a given modality will be null.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.