GET
/templates/{template_type}DeprecatedList all templates
Returns a list of all templates. The templates are returned sorted by position.
template_typestringrequired
The type of templates to list (email or SMS)
paginatedbooleanoptional
Whether to paginate the results.
If true, the results will be paginated.
If false, the results will not be paginated.
limitintegeroptional
Applies a limit to the number of results returned.
Can be used for paginating the results together with `offset`.
offsetintegeroptional
Skip the first `offset` results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with `limit`.
200Success
idstringoptional
objectstringoptional
String representing the object's type. Objects of the same type share the same value.
instance_idstringoptional
The ID of the instance to which the template belongs
resource_typestringoptional
whether this is a system (default) or user overridden) template
template_typestringoptional
whether this is an email or SMS template
namestringoptional
user-friendly name of the template
slugstringoptional
machine-friendly name of the template
positionintegeroptional
position with the listing of templates
can_revertbooleanoptional
whether this template can be reverted to the corresponding system default
can_deletebooleanoptional
whether this template can be deleted
can_edit_bodybooleanoptional
whether the body of this template can be edited
can_togglebooleanoptional
whether this template can be enabled or disabled, true only for notification SMS templates
subjectstringoptional
email subject
markupstringoptional
the editor markup used to generate the body of the template
bodystringoptional
the template body before variable interpolation
available_variablesarray<string>optional
list of variables that are available for use in the template body
required_variablesarray<string>optional
list of variables that must be contained in the template body
from_email_namestringoptional
reply_to_email_namestringoptional
delivered_by_clerkbooleanoptional
enabledbooleanoptional
flagged_as_suspiciousbooleanoptional
updated_atintegeroptional
Unix timestamp of last update.
created_atintegeroptional
Unix timestamp of creation.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
Error handling
A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 422 is returned: Invalid request parameters.