Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceEntityEmail Template

Get all email templates

GET
https://api.mercoa.com/entity/:entityId/email-templates
GET
/entity/:entityId/email-templates
1from mercoa import Mercoa
2
3client = Mercoa(
4 token="YOUR_TOKEN",
5)
6client.entity.email_template.get_all(
7 entity_id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
8)
Try it
1[
2 {
3 "id": "emt_8545a84e-a45f-41bf-bdf1-33b42a55812c",
4 "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
5 "templateType": "PAYMENT",
6 "name": "Generic Payment Email",
7 "subject": "Action Required - Your payment is due",
8 "content": "<h1>Your invoice has been sent.</h1>",
9 "isDefault": true
10 }
11]
Get all email templates for the entity
Was this page helpful?
Previous

Create entity email template

Next
Built with
Create entity email template
Get all email templates for the entity

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Response

This endpoint returns a list of objects.
idstring
entityIdstring
The ID of the entity that this email template is associated with.
templateTypeenum
Allowed values:
namestring
The name of the email template.
subjectstring
The subject of the email template.
contentstring
The HTML content of the email template.
isDefaultboolean
True if this email template is the default template for new invoices.

Errors

The HTML content of the email template.
True if this email template is the default template for new invoices.
Entity ID or Entity ForeignID

Bearer authentication of the form Bearer <token>, where token is your auth token.