Templates
Operations related to form templates
Page number (default: 1)
Items per page (default: 100)
Returns a paginated list of templates
GET /api/template HTTP/1.1
Host:
Accept: */*
Returns a paginated list of templates
No content
The name of the template
The description of the template
The version of the template
The schema of the template
Wheter the template was generated using AI
The vendor schema name
The vendor schema version
The vendor schema
The dereferenced vendor schema with resolved $ref references
The email alias
The state of the template
publishedPossible values: Creates a new template
POST /api/template HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"name": "text",
"description": "text",
"version": 1,
"schema": {},
"aiGenerated": true,
"vendorSchemaName": "text",
"vendorSchemaVersion": 1,
"vendorSchema": {},
"dereferencedVendorSchema": {},
"emailAlias": "text",
"state": "published"
}Creates a new template
No content
GET /api/template/{id} HTTP/1.1
Host:
Accept: */*
No content
The name of the template
The description of the template
The version of the template
The schema of the template
The vendor schema name
The vendor schema version
The vendor schema
The dereferenced vendor schema with resolved $ref references
The email alias
The uuid of extraction strategy template uses.
The state of the template
publishedPossible values: the parsing instructions for a template
Updates an existing template
PUT /api/template/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"name": "text",
"description": "text",
"version": 1,
"schema": {},
"vendorSchemaName": "text",
"vendorSchemaVersion": 1,
"vendorSchema": {},
"dereferencedVendorSchema": {},
"emailAlias": "text",
"extractionStrategyId": "text",
"state": "published",
"parsingInstructions": {}
}Updates an existing template
No content
Soft deletes an existing template
DELETE /api/template/{id} HTTP/1.1
Host:
Accept: */*
Soft deletes an existing template
No content
Template ID
The name of the template
The description of the template
The version of the template
The schema of the template
The vendor schema name
The vendor schema version
The vendor schema
The dereferenced vendor schema with resolved $ref references
The email alias
The uuid of extraction strategy template uses.
The state of the template
publishedPossible values: the parsing instructions for a template
The template has been successfully updated
PATCH /api/template/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"name": "text",
"description": "text",
"version": 1,
"schema": {},
"vendorSchemaName": "text",
"vendorSchemaVersion": 1,
"vendorSchema": {},
"dereferencedVendorSchema": {},
"emailAlias": "text",
"extractionStrategyId": "text",
"state": "published",
"parsingInstructions": {}
}The template has been successfully updated
{
"name": "text",
"description": "text",
"version": 1,
"schema": {},
"vendorSchemaName": "text",
"vendorSchemaVersion": 1,
"vendorSchema": {},
"dereferencedVendorSchema": {},
"emailAlias": "text",
"extractionStrategyId": "text",
"state": "published",
"parsingInstructions": {}
}Page number (default: 1)
Items per page (default: 10)
Returns a paginated list of submissions for the specified template
GET /api/template/{id}/submissions HTTP/1.1
Host:
Accept: */*
Returns a paginated list of submissions for the specified template
No content
The updated schema from Ledger
The vendor schema name
The vendor schema name (alternative)
The vendor schema version
The vendor schema version (alternative)
The vendor schema
The vendor schema (alternative snake_case)
The dereferenced vendor schema with resolved $ref references
transforms Ledger schema into a formflow template
POST /api/template/import-from-ledger HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 184
{
"schema": {},
"vendorSchemaName": "text",
"vendor_schema_name": "text",
"vendorSchemaVersion": 1,
"vendor_schema_version": 1,
"vendorSchema": {},
"vendor_schema": {},
"dereferencedVendorSchema": {}
}transforms Ledger schema into a formflow template
No content
Template ID to duplicate
Creates a duplicate of the existing template with all AI hints preserved
POST /api/template/{id}/duplicate HTTP/1.1
Host:
Accept: */*
Creates a duplicate of the existing template with all AI hints preserved
No content
Template ID to update from Ledger
The updated schema from Ledger
The vendor schema name
The vendor schema name (alternative)
The vendor schema version
The vendor schema version (alternative)
The vendor schema
The vendor schema (alternative snake_case)
The dereferenced vendor schema with resolved $ref references
Creates a new template with updated schema from Ledger while preserving AI hints
POST /api/template/{id}/update-from-ledger HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 184
{
"schema": {},
"vendorSchemaName": "text",
"vendor_schema_name": "text",
"vendorSchemaVersion": 1,
"vendor_schema_version": 1,
"vendorSchema": {},
"vendor_schema": {},
"dereferencedVendorSchema": {}
}Creates a new template with updated schema from Ledger while preserving AI hints
No content
Last updated
Was this helpful?