Skip to content
API reference/Templates

Get a template

Try it

One template with the pages and forms a new site made from it starts with.

GET/api/v1/templates/{template_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the templates:read scope — read templates, packages and section types.

templates:readRead onlyMCP tool: get_template

Parameters

Named placeholders go in the path; the rest in the query string.

template_idstringPath · required
The template's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl
curl -X GET 'https://websites.workflowcorp.com/api/v1/templates/TEMPLATE_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"
Example arguments
{
  "template_id": "TEMPLATE_ID"
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "industry": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "is_blank": {
      "type": "boolean"
    },
    "saved_by_you": {
      "type": "boolean",
      "description": "A template your account saved from one of its own sites."
    },
    "version": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "preview_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "hidden": {
            "type": "boolean"
          },
          "section_types": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "title",
          "slug",
          "hidden",
          "section_types"
        ],
        "additionalProperties": false
      }
    },
    "forms": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "field_labels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "field_labels"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "slug",
    "name",
    "industry",
    "description",
    "is_blank",
    "saved_by_you",
    "version",
    "preview_url",
    "pages",
    "forms"
  ],
  "additionalProperties": false
}