Get a custom domain

Returns a single custom domain configuration by ID.

GET /api/v2/domains/{config_id}

Get a custom domain

cURL

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

200

{
  "data": {
    "id": "<string>",
    "domain": "<string>",
    "cname_target": "<string>",
    "status": "<string>",
    "active": true,
    "created_at": 123,
    "updated_at": 123,
    "object": "domain"
  },
  "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

config_id · string · required

Response

200

application/json

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.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.