Templates

Operations related to form templates

get

Authorizations

access-token

Query parameters

pagenumberOptional

Page number (default: 1)

perPagenumberOptional

Items per page (default: 100)

Responses

200

Returns a paginated list of templates

No content

get

/api/template

HTTPcURLJavaScriptPython

GET /api/template HTTP/1.1
Accept: */*

200

Returns a paginated list of templates

No content

post

Authorizations

access-token

Body

application/json

namestringRequired

The name of the template

descriptionstringOptional

The description of the template

versionnumberRequired

The version of the template

schemaobjectOptional

The schema of the template

aiGeneratedbooleanOptional

Wheter the template was generated using AI

vendorSchemaNamestringOptional

The vendor schema name

vendorSchemaVersionnumberOptional

The vendor schema version

vendorSchemaobjectOptional

The vendor schema

dereferencedVendorSchemaobjectOptional

The dereferenced vendor schema with resolved $ref references

emailAliasstringOptional

The email alias

statestring · enumOptional

The state of the template

Default: publishedPossible values:

Responses

201

Creates a new template

post

/api/template

HTTPcURLJavaScriptPython

POST /api/template HTTP/1.1
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"
}

201

Creates a new template

No content

get

Authorizations

access-token

Path parameters

idnumberRequired

Responses

200Success

No content

get

/api/template/{id}

HTTPcURLJavaScriptPython

GET /api/template/{id} HTTP/1.1
Accept: */*

200Success

No content

put

Authorizations

access-token

Path parameters

idnumberRequired

Body

application/json

namestringOptional

The name of the template

descriptionstringOptional

The description of the template

versionnumberOptional

The version of the template

schemaobjectOptional

The schema of the template

vendorSchemaNamestringOptional

The vendor schema name

vendorSchemaVersionnumberOptional

The vendor schema version

vendorSchemaobjectOptional

The vendor schema

dereferencedVendorSchemaobjectOptional

The dereferenced vendor schema with resolved $ref references

emailAliasstringOptional

The email alias

extractionStrategyIdstringOptional

The uuid of extraction strategy template uses.

statestring · enumOptional

The state of the template

Default: publishedPossible values:

parsingInstructionsobjectOptional

the parsing instructions for a template

Responses

200

Updates an existing template

No content

put

/api/template/{id}

HTTPcURLJavaScriptPython

PUT /api/template/{id} HTTP/1.1
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": {}
}

200

Updates an existing template

No content

delete

Authorizations

access-token

Path parameters

idnumberRequired

Responses

204

Soft deletes an existing template

delete

/api/template/{id}

HTTPcURLJavaScriptPython

DELETE /api/template/{id} HTTP/1.1
Accept: */*

204

Soft deletes an existing template

No content

Update template

patch

Authorizations

access-token

Path parameters

idnumberRequired

Template ID

Body

application/json

namestringOptional

The name of the template

descriptionstringOptional

The description of the template

versionnumberOptional

The version of the template

schemaobjectOptional

The schema of the template

vendorSchemaNamestringOptional

The vendor schema name

vendorSchemaVersionnumberOptional

The vendor schema version

vendorSchemaobjectOptional

The vendor schema

dereferencedVendorSchemaobjectOptional

The dereferenced vendor schema with resolved $ref references

emailAliasstringOptional

The email alias

extractionStrategyIdstringOptional

The uuid of extraction strategy template uses.

statestring · enumOptional

The state of the template

Default: publishedPossible values:

parsingInstructionsobjectOptional

the parsing instructions for a template

Responses

200

The template has been successfully updated

application/json

patch

/api/template/{id}

HTTPcURLJavaScriptPython

PATCH /api/template/{id} HTTP/1.1
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": {}
}

200

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": {}
}

get

Authorizations

access-token

Path parameters

idnumberRequired

Query parameters

pagenumberOptional

Page number (default: 1)

perPagenumberOptional

Items per page (default: 10)

Responses

200

Returns a paginated list of submissions for the specified template

No content

get

/api/template/{id}/submissions

HTTPcURLJavaScriptPython

GET /api/template/{id}/submissions HTTP/1.1
Accept: */*

200

Returns a paginated list of submissions for the specified template

No content

Import schema from Ledger

post

Authorizations

access-token

Body

application/json

schemaobjectOptional

The updated schema from Ledger

vendorSchemaNamestringOptional

The vendor schema name

vendor_schema_namestringOptional

The vendor schema name (alternative)

vendorSchemaVersionnumberOptional

The vendor schema version

vendor_schema_versionnumberOptional

The vendor schema version (alternative)

vendorSchemaobjectOptional

The vendor schema

vendor_schemaobjectOptional

The vendor schema (alternative snake_case)

dereferencedVendorSchemaobjectOptional

The dereferenced vendor schema with resolved $ref references

Responses

201

transforms Ledger schema into a formflow template

post

/api/template/import-from-ledger

HTTPcURLJavaScriptPython

POST /api/template/import-from-ledger HTTP/1.1
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": {}
}

201

transforms Ledger schema into a formflow template

No content

Duplicate an existing template

post

Authorizations

access-token

Path parameters

idnumberRequired

Template ID to duplicate

Responses

201

Creates a duplicate of the existing template with all AI hints preserved

post

/api/template/{id}/duplicate

HTTPcURLJavaScriptPython

POST /api/template/{id}/duplicate HTTP/1.1
Accept: */*

201

Creates a duplicate of the existing template with all AI hints preserved

No content

Import updated schema from Ledger

post

Authorizations

access-token

Path parameters

idnumberRequired

Template ID to update from Ledger

Body

application/json

schemaobjectOptional

The updated schema from Ledger

vendorSchemaNamestringOptional

The vendor schema name

vendor_schema_namestringOptional

The vendor schema name (alternative)

vendorSchemaVersionnumberOptional

The vendor schema version

vendor_schema_versionnumberOptional

The vendor schema version (alternative)

vendorSchemaobjectOptional

The vendor schema

vendor_schemaobjectOptional

The vendor schema (alternative snake_case)

dereferencedVendorSchemaobjectOptional

The dereferenced vendor schema with resolved $ref references

Responses

201

Creates a new template with updated schema from Ledger while preserving AI hints

post

/api/template/{id}/update-from-ledger

HTTPcURLJavaScriptPython

POST /api/template/{id}/update-from-ledger HTTP/1.1
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": {}
}

201

Creates a new template with updated schema from Ledger while preserving AI hints

No content