Skip to main content
GET
Get a custom domain

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

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

Optional metadata. Shape varies by endpoint.