Templates

A template is a ready-made form that you can copy into your workspace. For fields and response details, see the API reference for listing templates, a single template and creating a form from a template.

List templates

This command lists the available templates. Use this to find a template’s ID, or narrow the list with --search (words in the title) and --category.

neetoform templates list --category Feedback --json

Flag	Type	Default	Description
`--category`	`string`		Filter by category name
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)
`--search`	`string`		Filter by title text

Sample output (--json)

{
  "data": [
    {
      "id": "4e2a9b1c-7d3f-4c8e-9a5b-1f0e2d3c4b5a",
      "title": "Customer feedback",
      "slug": "customer-feedback",
      "categories": ["Feedback"],
      "preview_url": "https://templates.neetoform.com/abc123?embedPreview=true&templateView=true&disable_widgets=true"
    }
  ],
  "breadcrumbs": [
    {
      "label": "Show",
      "command": "neetoform templates show <id-or-slug>"
    },
    {
      "label": "Use",
      "command": "neetoform templates use <template-id>"
    }
  ],
  "pagination": {
    "current_page_number": 1,
    "total_pages": 1,
    "total_records": 1,
    "page_size": 30
  }
}

Show a template

This command shows one template with its questions. Use this to check what a template contains before you use it.

neetoform templates show customer-feedback --json

Required arguments:

<id-or-slug> - The template’s UUID or slug, from neetoform templates list

Sample output (--json)

{
  "data": {
    "id": "4e2a9b1c-7d3f-4c8e-9a5b-1f0e2d3c4b5a",
    "title": "Customer feedback",
    "slug": "customer-feedback",
    "categories": ["Feedback"],
    "preview_url": "https://templates.neetoform.com/abc123?embedPreview=true&templateView=true&disable_widgets=true",
    "questions": [
      {
        "id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
        "label": "Email address",
        "kind": "email",
        "slug": "email",
        "position": 1,
        "is_required": true,
        "is_hidden": false
      }
    ]
  }
}

Use a template

This command creates a new draft form from a template. Use this to start a form without building it from scratch.

neetoform templates use 4e2a9b1c-7d3f-4c8e-9a5b-1f0e2d3c4b5a --created-by-email oliver@example.com

Required arguments:

<template-id> - The template’s UUID, from neetoform templates list. A slug does not work here.

Flag	Type	Required	Default	Description
`--created-by-email`	`string`			Email of the active team member who owns the new form; defaults to the signed-in user

The new form is not published. Publish it with neetoform forms publish <form-id> when it is ready.

Getting started

Commands

List templates

Show a template

Use a template

​List templates

​Show a template

​Use a template

List templates

Show a template

Use a template