Rendley docs

Templates

List templates

GET /v1/templates

Retrieve a paginated list of templates with optional search and category filtering.

Request

curl "https://api.rendley.com/v1/templates"
const res = await fetch("https://api.rendley.com/v1/templates", {
});
const { data } = await res.json();
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates",
)
data = res.json()["data"]

Query parameters

Name Type Required Description
page string Optional Page number
limit string Optional Results per page
query string Optional Search query
category_id string Optional Category ID filter
Example response
{
  "data": [
    {
      "fit_duration": 0,
      "height": 0,
      "id": "string",
      "is_premium": true,
      "name": "string",
      "preview_video_url": "string",
      "template_json": "string",
      "thumbnail_url": "string",
      "width": 0
    }
  ]
}
Response codes
Status Description
200 OK

Get a template

GET /v1/templates/{id}

Retrieve a single template by its ID.

Request

curl "https://api.rendley.com/v1/templates/ID"
const res = await fetch("https://api.rendley.com/v1/templates/ID", {
});
const { data } = await res.json();
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates/ID",
)
data = res.json()["data"]

Path parameters

Name Type Description
id string Template ID
Example response
{
  "data": {
    "fit_duration": 0,
    "height": 0,
    "id": "string",
    "is_premium": true,
    "name": "string",
    "preview_video_url": "string",
    "template_json": "string",
    "thumbnail_url": "string",
    "width": 0
  }
}
Response codes
Status Description
200 OK
404 Not Found

List template categories

GET /v1/templates/categories

Retrieve all available template categories.

Request

curl "https://api.rendley.com/v1/templates/categories"
const res = await fetch("https://api.rendley.com/v1/templates/categories", {
});
const { data } = await res.json();
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates/categories",
)
data = res.json()["data"]
Example response
{
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}
Response codes
Status Description
200 OK

Get templates overview

GET /v1/templates/overview

Retrieve an overview of templates grouped by category.

Request

curl "https://api.rendley.com/v1/templates/overview"
const res = await fetch("https://api.rendley.com/v1/templates/overview", {
});
const { data } = await res.json();
import requests

res = requests.get(
    "https://api.rendley.com/v1/templates/overview",
)
data = res.json()["data"]

Query parameters

Name Type Required Description
limit string Optional Number of templates per category
Example response
{
  "data": [
    {
      "category_id": "string",
      "category_name": "string",
      "templates": [
        {
          "fit_duration": 0,
          "height": 0,
          "id": "string",
          "is_premium": true,
          "name": "string",
          "preview_video_url": "string",
          "template_json": "string",
          "thumbnail_url": "string",
          "width": 0
        }
      ]
    }
  ]
}
Response codes
Status Description
200 OK