Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Email Templates

Get Template By Type

Lists all the email configurations defined within an environment.

get/v2/facts/{proj_id}/{env_id}/email_templates/{template_type}

Path parameters

template_type'approval_flows' | 'user_management' | 'test_email' required

An enumeration.

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Response

Successful Response

template_type'approval_flows' | 'user_management' | 'test_email' required

An enumeration.

idstring uuid required

Unique id of the EmailTemplate

organization_idstring uuid required

Unique id of the organization that the EmailTemplate belongs to.

project_idstring uuid required

Unique id of the project that the EmailTemplate belongs to.

environment_idstring uuid required

Unique id of the environment that the EmailTemplate belongs to.

from_addressstring email required

The from address the mails will be sent from

redirect_tostring uri required

The redirect url the user will be redirected to after clicking the link in the email

url_ttlstring required

The time to live of the url in the email, in seconds

subjectstring required

The subject of the email template