# Email Templates

View email templates configured for candidate outreach.

## List email templates

> Returns all email templates configured for the workspace.

```json
{"openapi":"3.1.0","info":{"title":"HeyMilo Public API","version":"2.0.0"},"tags":[{"name":"Email Templates","description":"View email templates configured for candidate outreach."}],"servers":[{"url":"https://api.heymilo.ai","description":"Production"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"API key for authentication. Pass your key in the X-API-KEY header."}},"schemas":{"ListResponse_EmailTemplateResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EmailTemplateResponse"},"type":"array","title":"Data"},"pagination":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","pagination"],"title":"ListResponse[EmailTemplateResponse]"},"EmailTemplateResponse":{"properties":{"object":{"type":"string","const":"email_template","title":"Object","description":"Object type identifier.","default":"email_template"},"id":{"type":"string","title":"Id","description":"Unique email template identifier."},"template_key":{"type":"string","title":"Template Key","description":"Template key indicating the email type: 'WEB_INTERVIEW_INVITATION', 'WEB_INTERVIEW_NUDGE', 'RESUME_INVITATION', 'RESUME_NUDGE', 'FORM_INVITATION', 'FORM_NUDGE', 'WEB_INTERVIEW_FINAL_NUDGE', 'SCHEDULING_LINK_EMAIL', 'REPORT_READY_EMAIL'."},"name":{"type":"string","title":"Name","description":"Human-readable template name."},"subject":{"type":"string","title":"Subject","description":"Email subject line. Supports {{variable}} placeholders."},"content":{"type":"string","title":"Content","description":"Email HTML body. Supports {{variable}} placeholders."},"blackout_period":{"anyOf":[{"$ref":"#/components/schemas/BlackoutPeriod"},{"type":"null"}],"description":"Blackout period during which this email will not be sent."},"created_at":{"type":"number","title":"Created At","description":"Unix timestamp when the template was created."},"updated_at":{"type":"number","title":"Updated At","description":"Unix timestamp when the template was last updated."}},"type":"object","required":["id","template_key","name","subject","content","created_at","updated_at"],"title":"EmailTemplateResponse","description":"A single email template used for candidate communications.\n\nTemplates define the subject line and HTML body for emails sent at\nvarious stages of the interview workflow (invitations, nudges, etc.)."},"BlackoutPeriod":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the blackout period is active."},"timezone":{"type":"string","title":"Timezone","description":"IANA timezone identifier."},"start_hour":{"type":"integer","title":"Start Hour","description":"Start hour of the blackout window (0-23)."},"end_hour":{"type":"integer","title":"End Hour","description":"End hour of the blackout window (0-24, where 24 = midnight)."}},"type":"object","required":["enabled","timezone","start_hour","end_hour"],"title":"BlackoutPeriod","description":"Time window during which emails will not be sent."},"PaginationMeta":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"Whether more results exist beyond this page"},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"Total number of results (if available)"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL of this resource"}},"type":"object","required":["has_more"],"title":"PaginationMeta"},"APIErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/APIError"}},"type":"object","required":["error"],"title":"APIErrorResponse"},"APIError":{"properties":{"type":{"type":"string","title":"Type","description":"Error category"},"code":{"type":"string","title":"Code","description":"Machine-readable error code"},"message":{"type":"string","title":"Message","description":"Human-readable summary"},"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"},"APIErrorDetail":{"properties":{"code":{"type":"string","title":"Code","description":"Machine-readable error code"},"message":{"type":"string","title":"Message","description":"Human-readable explanation"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param","description":"Parameter that caused the error"}},"type":"object","required":["code","message"],"title":"APIErrorDetail"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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"}}},"paths":{"/api/v2/email-templates":{"get":{"tags":["Email Templates"],"summary":"List email templates","description":"Returns all email templates configured for the workspace.","operationId":"listEmailTemplates","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}},{"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/ListResponse_EmailTemplateResponse_"}}}},"401":{"description":"Invalid or missing API key.","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"}}}}}}}}}
```

## Get an email template

> Returns a single email template by ID.

```json
{"openapi":"3.1.0","info":{"title":"HeyMilo Public API","version":"2.0.0"},"tags":[{"name":"Email Templates","description":"View email templates configured for candidate outreach."}],"servers":[{"url":"https://api.heymilo.ai","description":"Production"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"API key for authentication. Pass your key in the X-API-KEY header."}},"schemas":{"SingleResponse_EmailTemplateResponse_":{"properties":{"data":{"$ref":"#/components/schemas/EmailTemplateResponse"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta","description":"Optional metadata. Shape varies by endpoint."}},"type":"object","required":["data"],"title":"SingleResponse[EmailTemplateResponse]"},"EmailTemplateResponse":{"properties":{"object":{"type":"string","const":"email_template","title":"Object","description":"Object type identifier.","default":"email_template"},"id":{"type":"string","title":"Id","description":"Unique email template identifier."},"template_key":{"type":"string","title":"Template Key","description":"Template key indicating the email type: 'WEB_INTERVIEW_INVITATION', 'WEB_INTERVIEW_NUDGE', 'RESUME_INVITATION', 'RESUME_NUDGE', 'FORM_INVITATION', 'FORM_NUDGE', 'WEB_INTERVIEW_FINAL_NUDGE', 'SCHEDULING_LINK_EMAIL', 'REPORT_READY_EMAIL'."},"name":{"type":"string","title":"Name","description":"Human-readable template name."},"subject":{"type":"string","title":"Subject","description":"Email subject line. Supports {{variable}} placeholders."},"content":{"type":"string","title":"Content","description":"Email HTML body. Supports {{variable}} placeholders."},"blackout_period":{"anyOf":[{"$ref":"#/components/schemas/BlackoutPeriod"},{"type":"null"}],"description":"Blackout period during which this email will not be sent."},"created_at":{"type":"number","title":"Created At","description":"Unix timestamp when the template was created."},"updated_at":{"type":"number","title":"Updated At","description":"Unix timestamp when the template was last updated."}},"type":"object","required":["id","template_key","name","subject","content","created_at","updated_at"],"title":"EmailTemplateResponse","description":"A single email template used for candidate communications.\n\nTemplates define the subject line and HTML body for emails sent at\nvarious stages of the interview workflow (invitations, nudges, etc.)."},"BlackoutPeriod":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the blackout period is active."},"timezone":{"type":"string","title":"Timezone","description":"IANA timezone identifier."},"start_hour":{"type":"integer","title":"Start Hour","description":"Start hour of the blackout window (0-23)."},"end_hour":{"type":"integer","title":"End Hour","description":"End hour of the blackout window (0-24, where 24 = midnight)."}},"type":"object","required":["enabled","timezone","start_hour","end_hour"],"title":"BlackoutPeriod","description":"Time window during which emails will not be sent."},"APIErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/APIError"}},"type":"object","required":["error"],"title":"APIErrorResponse"},"APIError":{"properties":{"type":{"type":"string","title":"Type","description":"Error category"},"code":{"type":"string","title":"Code","description":"Machine-readable error code"},"message":{"type":"string","title":"Message","description":"Human-readable summary"},"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"},"APIErrorDetail":{"properties":{"code":{"type":"string","title":"Code","description":"Machine-readable error code"},"message":{"type":"string","title":"Message","description":"Human-readable explanation"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param","description":"Parameter that caused the error"}},"type":"object","required":["code","message"],"title":"APIErrorDetail"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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"}}},"paths":{"/api/v2/email-templates/{template_id}":{"get":{"tags":["Email Templates"],"summary":"Get an email template","description":"Returns a single email template by ID.","operationId":"getEmailTemplate","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template 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_EmailTemplateResponse_"}}}},"401":{"description":"Invalid or missing API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIErrorResponse"}}}},"404":{"description":"Email template 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"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.admin.heymilo.ai/api-next-gen/reference/email-templates.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.