Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HeyMilo Design Templates API

View design templates that control the candidate interview UI.

HeyMilo Design Templates API is one of 18 APIs that HeyMilo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Design Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.heymilo.ai.

2 operations 2 paths 9 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.heymilo.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HeyMilo Design Templates API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication. Pass your key in the X-API-KEY header.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Design Templates 2

View design templates that control the candidate interview UI.

GET
/api/v2/design-templates
List design templates
listDesignTemplates 6 params → 200401429422
GET
/api/v2/design-templates/{template_id}
Get a design template
getDesignTemplate 4 params → 200401429404422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are DesignTemplateResponse (7 properties), APIError (6 properties), APIErrorDetail (3 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

APIErrorDetail
object
3 properties 2 required
ListResponse_DesignTemplateResponse_
object
2 properties 2 required
APIError
object
6 properties 3 required
ValidationError
object
3 properties 3 required
APIErrorResponse
object
1 property 1 required
DesignTemplateResponse
object
A design template controlling the visual appearance of candidate-facing pages. Design templates define colors, fonts, images, and text for pages such as the we…
7 properties 6 required
SingleResponse_DesignTemplateResponse_
object
2 properties 1 required
HTTPValidationError
object
1 property
PaginationMeta
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-design-templates-api-openapi.yml Raw ↑

Other APIs HeyMilo publishes across the network.

HeyMilo ATS API
HeyMilo Candidates API
HeyMilo Design Template Groups API
HeyMilo Domains API
HeyMilo Email Template Groups API
HeyMilo Email Templates API
HeyMilo Health API
HeyMilo Interview Templates API
HeyMilo Interviewers API
HeyMilo Interviews API
HeyMilo Phone Numbers API
HeyMilo Questions API