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.

Parameter	Example	Description
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	email	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

Get a List of All Templates

get

Retrieve a list of all templates in the catalog.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

ResponsestringExample: {"count":1726,"next":"https://api.getbee.io/v1/catalog/templates/?page=2","previous":null,"results":[{"categories":["others"],"collections":"","context":"free","description":"","short_description":"","designer":"beefree-team","id":"empty","is_blank":true,"template_type":"email","order":"99999999","published_at":"2017-08-28","tags":["black","light","promote","serif","two-column","white"],"thumbnail_large":"https://d1oco4z2z1fhwp.cloudfront.net/templates/default/1_large.jpg","thumbnail":"https://d1oco4z2z1fhwp.cloudfront.net/templates/default/1.jpg","title":"Empty"},{"categories":["others"],"collections":"","context":"free","description":"","short_description":"","designer":"beefree-team","id":"empty-page","is_blank":true,"template_type":"page","order":"99999998","published_at":"2021-07-19","tags":[],"thumbnail_large":"https://d1oco4z2z1fhwp.cloudfront.net/templates/default/4246_large.jpg","thumbnail":"https://d1oco4z2z1fhwp.cloudfront.net/templates/default/4246.jpg","title":"Empty Page"}],"facets":{"categories":[{"id":"events","name":"Events","parent":"usage","count":353},{"id":"seasonal-promotion","name":"Seasonal Promotion","parent":"seasonal","count":345},{"id":"e-commerce","name":"E-commerce","parent":"industry","count":316}]}}

400

Bad request. The request could not be understood or was missing required parameters.

401

Unauthorized. Authentication is required and has failed or has not been provided.

403

Forbidden. The request was valid, but the server is refusing action.

500

Internal Server Error. An unexpected condition was encountered.

get

/v1/catalog/templates

HTTPcURLJavaScriptPython

GET /v1/catalog/templates HTTP/1.1
Host: api.getbee.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1726,
  "next": "https://api.getbee.io/v1/catalog/templates/?page=2",
  "previous": null,
  "results": [
    {
      "categories": [
        "others"
      ],
      "collections": "",
      "context": "free",
      "description": "",
      "short_description": "",
      "designer": "beefree-team",
      "id": "empty",
      "is_blank": true,
      "template_type": "email",
      "order": "99999999",
      "published_at": "2017-08-28",
      "tags": [
        "black",
        "light",
        "promote",
        "serif",
        "two-column",
        "white"
      ],
      "thumbnail_large": "https://d1oco4z2z1fhwp.cloudfront.net/templates/default/1_large.jpg",
      "thumbnail": "https://d1oco4z2z1fhwp.cloudfront.net/templates/default/1.jpg",
      "title": "Empty"
    },
    {
      "categories": [
        "others"
      ],
      "collections": "",
      "context": "free",
      "description": "",
      "short_description": "",
      "designer": "beefree-team",
      "id": "empty-page",
      "is_blank": true,
      "template_type": "page",
      "order": "99999998",
      "published_at": "2021-07-19",
      "tags": [],
      "thumbnail_large": "https://d1oco4z2z1fhwp.cloudfront.net/templates/default/4246_large.jpg",
      "thumbnail": "https://d1oco4z2z1fhwp.cloudfront.net/templates/default/4246.jpg",
      "title": "Empty Page"
    }
  ],
  "facets": {
    "categories": [
      {
        "id": "events",
        "name": "Events",
        "parent": "usage",
        "count": 353
      },
      {
        "id": "seasonal-promotion",
        "name": "Seasonal Promotion",
        "parent": "seasonal",
        "count": 345
      },
      {
        "id": "e-commerce",
        "name": "E-commerce",
        "parent": "industry",
        "count": 316
      }
    ]
  }
}

Fetch a single Template

/v1/catalog/templates/:slug

HTTP Method: GET

Description: Fetch a single template identified by its slug (in the URL).

Get a Template

get

Get a specific template from the catalog.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

ResponsestringExample: {"message":"Success"}

400

Bad request. The request could not be understood or was missing required parameters.

401

Unauthorized. Authentication is required and has failed or has not been provided.

403

Forbidden. The request was valid, but the server is refusing action.

500

Internal Server Error. An unexpected condition was encountered.

get

/v1/catalog/templates/:slug

HTTPcURLJavaScriptPython

GET /v1/catalog/templates/:slug HTTP/1.1
Host: api.getbee.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Success"
}