Email Templates

Make a GET request to /email-templates to retrieve the email templates available to your account.

This includes account-owned templates and system templates enabled for your account. Use template id values when creating invitations or verifying user defaults. See Create Invitation and Users.

GET /email-templates

{
    "mode": "live",
    "object": "list",
    "total_count": 2,
    "has_more": false,
    "data": [
        {
            "object": "email_template_list_item",
            "id": 1000,
            "display_name": "CoffeeBean Invitation",
            "type": "invitation",
            "team_ids": [178, 328]
        },
        {
            "object": "email_template_list_item",
            "id": 1001,
            "display_name": "Standard Congrats",
            "type": "congrats",
            "team_ids": []
        }
    ]
}

Response fields

List envelope

Field	Description
mode	"live" or "test" depending on your API key
object	Always "list"
total_count	Total number of email templates available to your account
has_more	true if more items exist beyond the current page
data	Array of email_template_list_item objects

email_template_list_item fields

Field	Description
object	Always "email_template_list_item"
id	Template ID. Use as email_template_id or congrats_email_template_id on invitations.
display_name	Human-readable template name
type	"invitation" or "congrats"
team_ids	Team IDs this template is assigned to for account-owned templates. Empty for account-wide system templates.

With a test API key, returns fake template data. See API Keys.