Templates
This page lists and describes the Templates category of endpoints within the Template Catalog API. It also includes interactive testing environments for each endpoint in this category.
Get a list of all Templates
/v1/catalog/templates
HTTP Method: GET
Description: Retrieve a list of all the Templates within the catalog, applying filters based on request parameters.
You can execute a search by providing a series of terms within the ‘search’ request parameter. This search will operate on template title, description, category name, collection name, designer name, publication date (‘published_at’), and tags.
The response will encompass a ‘facets’ field, outlining the count of existing Templates across each Category, Collections, Designers, and Tags fields and their sub-fields, considering any applied filters and searches.
The response is paginated, presenting 20 items per page by default. The ‘pagesize’ request parameter enables control over the page size.
Request Parameters
The following table displays a list of request parameters.
search
activity, beach, summer
List of terms to search, separated by comma
category
small-business
Filter by category slug
collection
e-commerce
Filter by collection slug
designer
bee-team
Filter by designer slug
tag
activity, beach, summer
Filter by tag name
template_type
Filter by template_type. Choiches are "email" or "page"
pagesize
20
Set the item number per page
published_after
2023-01-01
Filter by published_at after given date
published_before
2023-01-01
Filter by published_at before given date
Fetch a single Template
/v1/catalog/templates/:slug
HTTP Method: GET
Description: Fetch a single template identified by its slug (in the URL).
Last updated
Was this helpful?