Skip to content
FSCO Docs

Get templates

GET
/v2/document/template

List all the templates

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
tag
string

The tag

page[number]
number

Page number (starts at 1)

Example
1
page[size]
number

Items per page

Example
10

Header Parameters

Section titled “Header Parameters ”
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of templates.

object
templates
required
Array<object>
object
templateVersionId

A unique template Version Id

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
templateId

A template Id grouped on version

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
version

The Template Version

number
1
name

A template name

string
JapaneseInvoice
description

A template description

string
Used for extract all documents from the japanese providers.
type

Type of template, usually associated with the type of document, but you can set your own classification

string
invoice
tag

Identifies your templates in the dashboard UI

string
customer-template
prompts

Group of prompts or properties to be extracted or analyzed from the document

Array<object>
object
id
required

A prompt Id

string
a1b2c3d4-5678-4e2a-9c1a-2b3c4d5e6f7a
name
required

A prompt name

string
Summary
fieldType
required

A field type

string
text
format
required

A format

string
string
description
required

A description

string
Whats the summary of the document?
itemType

An item type

string
string
children
Array<object> recursive
providerModel

The provider model

object
page
required
object
number
required

The current page number.

number
1
size
required

The number of items per page.

number
10
totalPages
required

The total number of pages available.

number
100
totalCount
required

The total number of items available.

number
1000
hasNext
required

Indicates whether there is a next page available.

boolean
true
hasPrev
required

Indicates whether there is a previous page available.

boolean
true