API Reference
Questionnaire Templates

Questionnaire Templates

Questionnaire templates define the structure of forms used in patient journeys — intake forms, clinical assessments, pre-booking questionnaires, and more.

Questionnaire templates are read-only via the API. Create and edit templates through the Jump dashboard.

Endpoints

MethodEndpointDescription
GET/questionnaire-templatesList templates
GET/questionnaire-templates/{id}Retrieve a template

POST, PATCH, and DELETE return 405 with guidance to use the Jump dashboard.

The Template Object

{
  "id": "qt_123e4567-e89b-12d3-a456-426614174000",
  "questionnaire_id": "q_456e7890-e89b-12d3-a456-426614174111",
  "title": "New Patient Intake Form",
  "description": "Standard intake questionnaire for new patients",
  "schema": { ... },
  "category": "intake",
  "tags": ["new-patient", "registration"],
  "is_clinical": false,
  "version": 1,
  "is_active": true,
  "key": "new_patient_intake",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

The schema field contains the full form definition (fields, validation rules, conditional logic).


List Templates

GET /questionnaire-templates

Returns both organisation-specific templates and system-wide templates.

Query Parameters

ParameterTypeDescription
limit / offsetintegerPagination (default 20)
searchstringSearch by title
categorystringFilter by category
is_clinicalstringFilter clinical vs non-clinical
is_activestringFilter active/inactive
keystringFilter by template key
created_at_gte / created_at_ltestringDate range filter

Related Resources