Skip to content
FSCO Docs

Get documents

GET
/v2/document

Get a list of documents

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
groupId
string

The document group id

Example
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
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 documents.

object
items
required

List of documents

Array<object>
object
documentId

A document Id

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
refId

A reference Id

string
b7e6a1c2-3f4d-4e2a-9c1a-2b3c4d5e6f7a
docExt

A document extension

string
application/pdf
docName

A document name

string
Invoice Q1 2024
docType

A document type

string
invoice
uploadBatchId

An upload batch Id

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
isPublic

Set the visibility of the document and its data

boolean
source

The origin of the document upload

string
groupId

The group id to add the document to

string
e3f4d5c6-7a8b-4e2a-9c1a-2b3c4d5e6f7a
prompts

A prompt array

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 
[
  {
    "id": "1",
    "name": "Total",
    "fieldType": "number",
    "format": "currency",
    "description": "The total amount of the document"
  }
]
webhookId

The webhook id to send the document to

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
bulkDocumentId

The bulk document id to add the document to

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
page
required

Pagination query

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