> ## 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. # Get a custom domain > Returns a single custom domain configuration by ID. ## OpenAPI ````yaml https://api.heymilo.ai/openapi.json get /api/v2/domains/{config_id} openapi: 3.1.0 info: title: HeyMilo Public API description: >- External developer-facing API for HeyMilo. Create interviewers with agentic workflows, ingest candidates, retrieve interview results, and manage workspace resources. version: 2.0.0 servers: - url: https://api.heymilo.ai description: Production security: - ApiKeyAuth: [] tags: - name: Interviewers description: >- Create, read, update, and manage interviewers. An interviewer (posting) combines job details with an AI agent configuration and agentic workflow. - name: Candidates description: >- Ingest candidates into an interviewer's workflow (sync or async, single or bulk) and list candidates with their progress. - name: Interviews description: >- Retrieve full interview results (scorecard, transcript, resume evaluation) and manage per-interview metadata. - name: Webhooks description: >- Register, list, and manage webhook endpoints that receive real-time event notifications. - name: Voices description: Browse the workspace voice registry for AI interviewer voices. - name: Phone Numbers description: List provisioned phone numbers for SMS and voice agents. - name: Sender Emails description: Manage sender email addresses used for candidate communications. - name: Email Templates description: View email templates configured for candidate outreach. - name: Email Template Groups description: View grouped email template configurations. - name: Design Templates description: View design templates that control the candidate interview UI. - name: Design Template Groups description: View grouped design template configurations. - name: Interview Templates description: >- View interview templates, reusable agent configurations cloned from a blueprint posting (workflow, questions, criteria, agent settings). - name: Domains description: Manage custom domains for white-labelled interview URLs. - name: Questions description: >- Create, read, update, delete, and reorder questions and criteria for an interviewer's workflow. Covers all modalities: voice, sms, form, resume_eligibility, resume_scoring, and voice_tags. - name: Workspaces description: >- List the workspaces accessible to the authenticated caller. API-key callers receive a single entry; OAuth callers receive every workspace they are a member of. paths: /api/v2/domains/{config_id}: get: tags: - Domains summary: Get a custom domain description: Returns a single custom domain configuration by ID. operationId: getDomain parameters: - name: config_id in: path required: true schema: type: string title: Config Id - name: X-API-KEY in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Api-Key - name: Authorization in: header required: false schema: anyOf: - type: string - type: 'null' title: Authorization - name: X-Workspace-Id in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Workspace-Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SingleResponse_CustomDomainResponse_' '401': description: Invalid or missing API key. content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Domain not found. content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' components: schemas: SingleResponse_CustomDomainResponse_: properties: data: $ref: '#/components/schemas/CustomDomainResponse' meta: anyOf: - additionalProperties: true type: object - type: 'null' title: Meta description: Optional metadata. Shape varies by endpoint. type: object required: - data title: SingleResponse[CustomDomainResponse] APIErrorResponse: properties: error: $ref: '#/components/schemas/APIError' type: object required: - error title: APIErrorResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CustomDomainResponse: properties: object: type: string const: domain title: Object description: Object type identifier. default: domain id: type: string title: Id description: Unique domain configuration identifier. examples: - BCE1C810 domain: type: string title: Domain description: The custom domain name. examples: - interviews.acme.com cname_target: type: string title: Cname Target description: CNAME target for DNS configuration. examples: - ingress.heymilo.ai status: type: string title: Status description: 'Domain verification status: ''pending'', ''active'', ''error''.' examples: - active active: type: boolean title: Active description: Whether the domain is verified and active for use. examples: - true created_at: type: number title: Created At description: Unix timestamp when the domain was created. examples: - 1739612400 updated_at: type: number title: Updated At description: Unix timestamp when the domain was last updated. examples: - 1739617200 type: object required: - id - domain - cname_target - status - active - created_at - updated_at title: CustomDomainResponse description: |- 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``. APIError: properties: type: type: string title: Type description: Error category examples: - invalid_request_error code: type: string title: Code description: Machine-readable error code examples: - validation_error message: type: string title: Message description: Human-readable summary examples: - The request body failed validation param: anyOf: - type: string - type: 'null' title: Param description: Top-level parameter that caused the error doc_url: anyOf: - type: string - type: 'null' title: Doc Url description: Link to relevant documentation errors: items: $ref: '#/components/schemas/APIErrorDetail' type: array title: Errors description: Detailed per-field validation errors type: object required: - type - code - message title: APIError ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError APIErrorDetail: properties: code: type: string title: Code description: Machine-readable error code examples: - invalid_param message: type: string title: Message description: Human-readable explanation examples: - title must be between 3 and 200 characters param: anyOf: - type: string - type: 'null' title: Param description: Parameter that caused the error examples: - title type: object required: - code - message title: APIErrorDetail securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: API key for authentication. Pass your key in the X-API-KEY header. ````