Skip to main content
GET
/
api
/
v2
/
postings
List interviewers
curl --request GET \
  --url https://api.heymilo.ai/api/v2/postings \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "company_id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "status": "<string>",
      "finalized": true,
      "archived": true,
      "test_posting": true,
      "object": "posting",
      "name": "senior-software-engineer",
      "language": "en",
      "interviewer_name": "Sarah",
      "workflow": [
        {
          "type": "<string>",
          "order": 123,
          "id": "agent_vi_001",
          "config": {}
        }
      ],
      "urls": {
        "candidate_url": "https://candidates.heymilo.io/acme/senior-engineer",
        "ingestion_url_key": "ibURejyPMSlw6de0OZUdoxyoXTgWO78ey2NUo96EOG1gY",
        "review_url": "https://admin.heymilo.ai/w/ABC123/lab2/POST_ID/1-details"
      },
      "deadline": 1775174400,
      "redirect_url": "https://acme.com/thank-you",
      "scheduling_url": "https://cal.com/acme/interview",
      "max_retakes": 1,
      "allow_sms_comms": false,
      "instructions": "<string>",
      "company_overview": "<string>",
      "job_overview": "<string>",
      "interview_process_overview": "<string>",
      "company_overview_delivery_mode": "<string>",
      "job_overview_delivery_mode": "<string>",
      "interview_process_overview_delivery_mode": "<string>",
      "phone_number_id": "<string>",
      "sender_email_id": "<string>",
      "email_template_group_id": "<string>",
      "design_template_group_id": "<string>",
      "retake_cooldown_days": 123,
      "email_report_to_candidate": false,
      "ats_metadata": {
        "ats_job_id": "WK-12345",
        "ats_name": "workable",
        "source": "job_sync"
      },
      "metadata": {
        "external_id": "ats_12345",
        "source": "workday"
      },
      "created_at": 1739612400,
      "updated_at": 1739617200
    }
  ],
  "pagination": {
    "has_more": true,
    "total_count": 123,
    "url": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
required

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
starting_after
string | null
title
string | null

Case-insensitive substring filter on the posting title.

Response

Successful Response

data
PostingResponse · object[]
required
pagination
PaginationMeta · object
required