Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Site Templates

List Site Templates

Get list of all Site Templates which can be used to create new sites

get/v1/sites/templates

Query parameters

created_from.site_idinteger
Example:8675309

If passed, will restrict the response to results matching the site ID the template was created from

created_from.domainstring
Example:our-favorite-woocommerce-setup.tld

If passed, will restrict the response to results matching the domain the template was created from

tagsstring[]

If passed, will restrict the response to results matching these tags

pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

sort'name' | 'created_at' | 'updated_at'

Which property to sort the results by

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": {
    "site_templates": [
      {
        "name": "WooCommerce with SEO Plugins",
        "template_id": "7ec25c75-b490-4365-bc55-7df7f1aa7c5e",
        "created_from": {
          "site_id": 8675309,
          "domain": "woocommerce-site-we-love.tld"
        },
        "config": {
          "wordpress": {
            "version": "6.4.1",
            "php_version": "8.2"
          }
        },
        "notes": "Our traditional WooCommerce site with SEO including X and Y plugins on Z theme.",
        "created_at": "2018-03-20T09:12:28Z",
        "updated_at": "2018-03-20T09:12:28Z"
      }
    ]
  }
}