Get a design template

Returns a single design template by ID.

GET /api/v2/design-templates/{template_id}

Get a design template

cURL

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

200

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "template_type": "<string>",
    "design_config": {},
    "created_at": 123,
    "updated_at": 123,
    "object": "design_template"
  },
  "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

template_id · string · required

Response

200

application/json

Successful Response

data · DesignTemplateResponse · object · required

A design template controlling the visual appearance of candidate-facing pages.

Design templates define colors, fonts, images, and text for pages such as the welcome page, interview page, status page, and interview-complete page.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.