{ "opencollection": "1.0.0", "info": { "name": "HeyMilo Public ATS Questions API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Questions", "type": "folder" }, "items": [ { "info": { "name": "List questions", "type": "http" }, "http": { "method": "GET", "url": "https://api.heymilo.ai/api/v2/postings/:posting_id/questions", "headers": [ { "name": "X-API-KEY", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "X-Workspace-Id", "value": "" } ], "params": [ { "name": "posting_id", "value": "", "type": "path" }, { "name": "modality", "value": "", "type": "query", "description": "Filter by question modality: voice, sms, form, resume_eligibility, resume_scoring, voice_tags." }, { "name": "limit", "value": "", "type": "query" }, { "name": "starting_after", "value": "", "type": "query" } ] }, "docs": "Returns all questions and criteria for a posting. Optionally filter by modality (voice, sms, form, resume_eligibility, resume_scoring, voice_tags)." }, { "info": { "name": "Create a question", "type": "http" }, "http": { "method": "POST", "url": "https://api.heymilo.ai/api/v2/postings/:posting_id/questions", "headers": [ { "name": "X-API-KEY", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "X-Workspace-Id", "value": "" } ], "params": [ { "name": "posting_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new question or criterion for a posting. The ``modality`` field determines the question type." }, { "info": { "name": "Retrieve a question", "type": "http" }, "http": { "method": "GET", "url": "https://api.heymilo.ai/api/v2/postings/:posting_id/questions/:question_id", "headers": [ { "name": "X-API-KEY", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "X-Workspace-Id", "value": "" } ], "params": [ { "name": "posting_id", "value": "", "type": "path" }, { "name": "question_id", "value": "", "type": "path" } ] }, "docs": "Returns a single question or criterion by its ID." }, { "info": { "name": "Update a question", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.heymilo.ai/api/v2/postings/:posting_id/questions/:question_id", "headers": [ { "name": "X-API-KEY", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "X-Workspace-Id", "value": "" } ], "params": [ { "name": "posting_id", "value": "", "type": "path" }, { "name": "question_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified question. Only fields present in the request body are modified; omitted fields remain unchanged." }, { "info": { "name": "Delete a question", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.heymilo.ai/api/v2/postings/:posting_id/questions/:question_id", "headers": [ { "name": "X-API-KEY", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "X-Workspace-Id", "value": "" } ], "params": [ { "name": "posting_id", "value": "", "type": "path" }, { "name": "question_id", "value": "", "type": "path" } ] }, "docs": "Soft-deletes a question or criterion. It will no longer appear in listings." }, { "info": { "name": "Reorder questions", "type": "http" }, "http": { "method": "POST", "url": "https://api.heymilo.ai/api/v2/postings/:posting_id/questions/reorder", "headers": [ { "name": "X-API-KEY", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "X-Workspace-Id", "value": "" } ], "params": [ { "name": "posting_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the display order for questions of a given modality. You must include every active question ID for the specified modality in the desired order." } ] } ], "bundled": true }