Categories
This page lists and describes the Categories category of endpoints within the Template Catalog API. It also includes interactive testing environments for each endpoint in this category.
Last updated
Was this helpful?
This page lists and describes the Categories category of endpoints within the Template Catalog API. It also includes interactive testing environments for each endpoint in this category.
Last updated
Was this helpful?
Was this helpful?
/v1/catalog/categories
HTTP Method: GET
Description: Retrieve a list of all the Templates within the catalog, applying filters based on request parameters.
You can extract a list of all the Categories present within the catalog. This comprehensive list includes all categories under which templates are classified.
The response that you receive is paginated for ease of reading and navigation. It displays 200 items per page by default, providing a comprehensive view of the catalog content.
However, if you wish to adjust the number of items shown on each page, you can use the ‘pagesize’ request parameter.
The following table displays request parameters.
pagesize
int
Set the item number per page
Get a list of categories from the catalog.
Successful response
{"count":114,"next":null,"previous":null,"results":[{"bg_color":"#F8F8F8","fb_color":"#333A45","highlighted":false,"icon":null,"id":"leap-year","image":null,"name":"Leap Year","description":"Make every extra day count with our Leap Year email templates. Whether you're celebrating a special promotion, organizing an exclusive event, or simply seizing the opportunity for a unique marketing campaign, our templates are designed to make your Leap Year messages stand out.","short_description":"Engage your audience with visually appealing designs that capture the essence of this rare occurrence.","parent":"seasonal"}]}Bad request. The request could not be understood or was missing required parameters.
Unauthorized. Authentication is required and has failed or has not been provided.
Forbidden. The request was valid, but the server is refusing action.
Internal Server Error. An unexpected condition was encountered.
GET /v1/catalog/categories HTTP/1.1
Host: api.getbee.io
Authorization: Bearer Enter Dev Console API Key as Bearer token
Accept: */*
{
"count": 114,
"next": null,
"previous": null,
"results": [
{
"bg_color": "#F8F8F8",
"fb_color": "#333A45",
"highlighted": false,
"icon": null,
"id": "leap-year",
"image": null,
"name": "Leap Year",
"description": "Make every extra day count with our Leap Year email templates. Whether you're celebrating a special promotion, organizing an exclusive event, or simply seizing the opportunity for a unique marketing campaign, our templates are designed to make your Leap Year messages stand out.",
"short_description": "Engage your audience with visually appealing designs that capture the essence of this rare occurrence.",
"parent": "seasonal"
}
]
}/v1/catalog/categories/:slug
HTTP Method: GET
Description: Retrieve a list of all the Templates within the catalog, applying filters based on request parameters.
Retrieve detailed information about a specific Category using its unique identifier, or slug, which can be found in the URL. This method allows you to access in-depth data related to that particular category, such as its associated templates and related metadata.
Retrieve a specific category in the catalog.
Successful response
{"bg_color":"#F8F8F8","fb_color":"#333A45","highlighted":false,"icon":null,"id":"fashion-week","image":null,"name":"Fashion Week","description":"Strut into the spotlight of style with our Fashion Week email templates. Whether you're unveiling a new collection or promoting exclusive runway-inspired deals, these templates offer a chic and visually captivating platform to make your mark during the most fashionable moments.","short_description":"Stand out this Fashion Week with our email and page templates","parent":"seasonal"}Bad request. The request could not be understood or was missing required parameters.
Unauthorized. Authentication is required and has failed or has not been provided.
Forbidden. The request was valid, but the server is refusing action.
Internal Server Error. An unexpected condition was encountered.
GET /v1/catalog/categories/:slug HTTP/1.1
Host: api.getbee.io
Authorization: Bearer Enter Dev Console API Key as Bearer token
Accept: */*
{
"bg_color": "#F8F8F8",
"fb_color": "#333A45",
"highlighted": false,
"icon": null,
"id": "fashion-week",
"image": null,
"name": "Fashion Week",
"description": "Strut into the spotlight of style with our Fashion Week email templates. Whether you're unveiling a new collection or promoting exclusive runway-inspired deals, these templates offer a chic and visually captivating platform to make your mark during the most fashionable moments.",
"short_description": "Stand out this Fashion Week with our email and page templates",
"parent": "seasonal"
}