Collections

This page lists and describes the Collections category of endpoints within the Template Catalog API. It also includes interactive testing environments for each endpoint in this category.

Fetch a List of Collections

/v1/catalog/collections

HTTP Method: GET

Description: You can pull up a full list of all Collections in the catalog. Collections are groups of templates with similar attributes or purposes. This overview can help you understand the types of template groupings available.

The response will be paginated, with 200 items per page default for easy navigation. However, you can change this default by adjusting the ‘pagesize’ request parameter to suit your viewing preferences.

Request Parameters

The following table displays request parameters.

Parameter	Value	Description
pagesize	int	Set the item number per page

Get a List of Collections

get

Get a list of collections from the catalog.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

stringOptionalExample: {"count":19,"next":"https://api.getbee.io/v1/catalog/collections?page=2&pagesize=10","previous":null,"results":[{"bg_color":"#E8F8D4","description":"A Beefree collection is a set of templates focused on a specific communication need. Whether you need to create an automated email sequence to onboard new customers, launch a new product, or dress up transactional messages for your online store, Beefree collections will help you hit the ground running and achieve your goals faster.","short_description":"","fg_color":"#140244","highlighted":false,"icon_url":"https://d1oco4z2z1fhwp.cloudfront.net/collections/real-estate_icon.svg","id":"real-estate","image_url":"https://d1oco4z2z1fhwp.cloudfront.net/collections/Real-Estate-TC.png","name":"Real Estate","order":"0"}]}

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/collections

HTTPcURLJavaScriptPython

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

{
  "count": 19,
  "next": "https://api.getbee.io/v1/catalog/collections?page=2&pagesize=10",
  "previous": null,
  "results": [
    {
      "bg_color": "#E8F8D4",
      "description": "A Beefree collection is a set of templates focused on a specific communication need. Whether you need to create an automated email sequence to onboard new customers, launch a new product, or dress up transactional messages for your online store, Beefree collections will help you hit the ground running and achieve your goals faster.",
      "short_description": "",
      "fg_color": "#140244",
      "highlighted": false,
      "icon_url": "https://d1oco4z2z1fhwp.cloudfront.net/collections/real-estate_icon.svg",
      "id": "real-estate",
      "image_url": "https://d1oco4z2z1fhwp.cloudfront.net/collections/Real-Estate-TC.png",
      "name": "Real Estate",
      "order": "0"
    }
  ]
}

Fetch a single Collection

/v1/catalog/collections/:slug

HTTP Method: GET

Description: Access a specific Collection using its unique slug found in the URL. This lets you view detailed information about this particular group of templates, including its associated templates and any related details.

Get a Collection

get

Retrieve a specific collection in the catalog.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

stringOptionalExample: {"bg_color":"#FBFBFB","description":"A Beefree collection is a set of templates focused on a specific communication need. Whether you need to create an automated email sequence to onboard new customers, launch a new product, or dress up transactional messages for your online store, Beefree collections will help you hit the ground running and achieve your goals faster.","short_description":"","fg_color":"#140242","highlighted":false,"icon_url":"https://d1oco4z2z1fhwp.cloudfront.net/collections/photo.svg","id":"photography","image_url":"https://d1oco4z2z1fhwp.cloudfront.net/collections/Photography-TC.png","name":"Photography","order":"0"}

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/collections/:slug

HTTPcURLJavaScriptPython

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

{
  "bg_color": "#FBFBFB",
  "description": "A Beefree collection is a set of templates focused on a specific communication need. Whether you need to create an automated email sequence to onboard new customers, launch a new product, or dress up transactional messages for your online store, Beefree collections will help you hit the ground running and achieve your goals faster.",
  "short_description": "",
  "fg_color": "#140242",
  "highlighted": false,
  "icon_url": "https://d1oco4z2z1fhwp.cloudfront.net/collections/photo.svg",
  "id": "photography",
  "image_url": "https://d1oco4z2z1fhwp.cloudfront.net/collections/Photography-TC.png",
  "name": "Photography",
  "order": "0"
}