Search Templates
Search email templates based on specific filter criteria like template name.
🔍 Search Templates
Use this endpoint to search templates by name or other attributes. This is useful for dynamically retrieving matching templates.
🔹 HTTP Request
GET API-URL/templates
🧾 Query Parameters
Parameter
Type
Default
Required
Description
page
int
1
No
Current page to retrieve.
per_page
int
10
No
Number of items per page.
filters
array
—
Yes
Indexed array of template attributes to filter by (e.g., name
).
🔐 Authorization Header
X-API-KEY: your-api-key-here
💻 PHP Example
// Search ALL ITEMS
$response = $endpoint->searchTemplates($pageNumber = 1, $perPage = 10, [
'name' => 'summer_offer_template'
]);
// DISPLAY RESPONSE
echo '<pre>';
print_r($response->body);
echo '</pre>';
📦 Sample JSON Response
{
"status": "success",
"data": {
"records": [
{
"name": "summer_offer_template",
"content": "HTML content...",
"screenshot": "https:\/\/demo.com\/frontend\/assets\/gallery\/tpl9847xyz123\/img_preview.png"
}
]
}
}
Last updated