Skip to content

Templates

You can use templates to control the look and content of the email notifications for your fax service. These templates are stored on a email domain that you can configure and manage using the /domains endpoints.

List templates for domain

Request

List templates for a specific domain for the specified service.

Security
BasicAuth or OAuth2
Path
serviceIdstringrequired

The serviceId containing the templates you want to list.

Example:01GVRB50KEQFFE1SGMPFRNBG6J
domainNamestringrequired

The name of the domain containing the templates you want to list.

Example:yourdomain.com
projectIdstringrequired

The projectId is a required parameter you must include when making any API calls. You can find your project ID on your Build dashboard.

Example:3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47
curl -i -X GET \
  -u '<username>:<password>' \
  https://fax.api.sinch.com/v3/projects/3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47/services/01GVRB50KEQFFE1SGMPFRNBG6J/domains/yourdomain.com/templates

Responses

The returned templates.

Bodyapplication/json
Array [
namestring(TemplateName)

The name of the email template.

Enum ValueDescription
successful outbound fax

The template for a successful outbound fax.

unsuccessful outbound fax

The template for an unsuccessful outbound fax.

successful inbound fax

The template for a successful inbound fax.

unsuccessful inbound fax

The template for an unsuccessful inbound fax.

Example:"successful outbound fax"
createdAtstring, (date-time)

The timestamp on which the template was created.

Example:"2025-10-24 19:11:50.235000+00:00"
descriptionstring

The description for the template.

Example:"Successful fax template"
]
Response
[ { "name": "successful outbound fax", "createdAt": "2025-10-24 19:11:50.235000+00:00", "description": "Successful fax template" } ]
We'd love to hear from you!
Rate this content: