SnozeDevelopers
API referenceDatabase templates

Create a database from a template

Builds a new database from a saved template's manifest, creating its fields and views, and returns the full database detail. Optional `label`, `parentItemId`, and `order` place the new database in the workspace tree. Requires `databases:write` in the workspace; an unknown template returns not-found.

POST
/v1/workspaces/{workspaceId}/database-templates/{templateId}/instantiate

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
templateId*string

Request Body

application/json
  1. body
label?string|null
parentItemId?string|null
order?number|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/database-templates/string/instantiate' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "id": "string",    "workspaceId": "string",    "itemId": "string",    "parentItemId": "string",    "key": "string",    "label": "string",    "description": "string",    "icon": "string",    "order": 0,    "hierarchyRevision": 0,    "settings": {},    "recordLayout": {      "version": 2,      "pageWidth": "default",      "propertyColumns": 1,      "propertyDensity": "comfortable",      "propertyOrder": [        "string"      ],      "hiddenFieldKeys": [        "string"      ],      "sections": [        {          "id": "string",          "label": "string",          "fieldKeys": [            "string"          ]        }      ],      "contentPosition": "before_properties",      "showComments": true,      "showActivity": true,      "pinnedFieldKeys": [        "string"      ],      "autoAddNewFields": true,      "collapsedSectionIds": [        "string"      ],      "relationViews": {        "property1": {          "defaultViewId": "string",          "position": "properties",          "collapsed": true        },        "property2": {          "defaultViewId": "string",          "position": "properties",          "collapsed": true        }      },      "showReferences": true    },    "archived": true,    "fields": [      {        "id": "string",        "workspaceId": "string",        "databaseId": "string",        "key": "string",        "label": "string",        "kind": "text",        "required": true,        "defaultValue": "string",        "options": [          {            "id": "string",            "key": "string",            "name": "string",            "color": "string",            "order": 0          }        ],        "settings": {},        "order": 0,        "createdAt": "string",        "updatedAt": "string"      }    ],    "views": [      {        "id": "string",        "workspaceId": "string",        "databaseId": "string",        "key": "string",        "label": "string",        "kind": "table",        "placement": "database",        "manifest": {},        "relationFieldId": "string",        "ownerUserId": "string",        "scope": "shared",        "locked": true,        "definitionVersion": 0,        "createdAt": "string",        "updatedAt": "string"      }    ],    "createdAt": "string",    "updatedAt": "string"  }}

Delete a database template

Removes a saved database template and records the deletion on the workspace event ledger; databases already created from it are untouched. Requires `databases:write` in the workspace, and an unknown template returns not-found.

Duplicate a database

Copies a database's fields, views, and settings into a new database named after the original, and copies its records as well when `includeRecords` is set. Requires read access to the source database and `databases:write` to create the copy; if record copying fails partway the new database is removed rather than left half-populated.