Skip to main content

Get Email Templates

This request returns the list of existing email templates.

get /verification/email/templates

Sample

A sample GET request to get email templates matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/verification/email/templates?exclude_fields=html_body' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Email Template objects:

{
"count": 2,
"has_more": false,
"items": [
{
"bcc_addresses": "jsmith@freeconferencecall.com",
"cc_addresses": null,
"from_address": "noreply@carrierx.com",
"name": "Forgot Partner Password template",
"subject": "QA: CarrierX Password Reset",
"template_sid": "465eb46b-05a7-4251-b89c-e99f2b81509b",
"text_body": "To complete your password reset, please click the link below:\n${base_url}?token=${uuid}\n\nYou are receiving this email because someone has initiated a password reset on\nyour account.\n\n4300 E. Pacific Coast Highway | Long Beach, CA | 90804\n",
"to_addresses": null,
"type": "forgot_partner_password"
},
{
"bcc_addresses": "jsmith@freeconferencecall.com",
"cc_addresses": null,
"from_address": "noreply@carrierx.com",
"name": "Email Verification template",
"subject": "QA: CarrierX Email Verification",
"template_sid": "3e9e8c56-e1ee-4dcf-9e2b-abbd101139ba",
"text_body": "Hello!\n \nPlease confirm your email address by pasting this link into your browser:\n${base_url}?token=${uuid}\n \nYou are receiving this email because you requested account access to\nhttp://www.carrierx.com/\n\n4300 E. Pacific Coast Highway | Long Beach, CA | 90804\n",
"to_addresses": null,
"type": "email_address_verification"
}
],
"limit": 1000,
"offset": 0,
"pagination": {},
"total": 2
}

Required Scopes

To get information about email templates, the partner must have one of the following scopes enabled:

  • verification.manage
  • verification.read