Skip to main content
GET
/
api
/
v2
/
domains
/
{config_id}
Get a custom domain
curl --request GET \
  --url https://api.heymilo.ai/api/v2/domains/{config_id} \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "id": "<string>",
    "domain": "<string>",
    "cname_target": "<string>",
    "status": "<string>",
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "object": "domain"
  },
  "meta": {}
}

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

Path Parameters

​
config_id
string
required

Response

Successful Response

​
data
CustomDomainResponse · object
required

A custom domain for candidate-facing interview URLs.

Custom domains allow workspaces to white-label the candidate experience (e.g. interviews.acme.com instead of candidates.heymilo.io). Domains require CNAME verification pointing to ingress.heymilo.ai.

​
meta
Meta · object

Optional metadata. Shape varies by endpoint.