Documents
Lists all documents
Documents
Lists all documents
GET
/
documents
curl --request GET \
--url https://api.sandbox.goteal.co/documents \
--header 'X-API-KEY: <api-key>'
{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"total_count": 89
},
"documents": [
{
"document_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
"file_name": "payslip1.pdf",
"document_external_id": "payslip123456",
"type": "Payslip",
"upload_time": "2019-05-17T00:00:00.000Z",
"file_contents": "/documents/a9249254-ab10-4a2d-b709-eda95f5ecd59"
}
]
}
Authorizations
Query Parameters
ID of the user to get documents for
The offset to start at
Required range:
x >= 0
The number of items to return
Required range:
1 <= x <= 100
Response
200
application/json
Document response
A unique document identifier
Example:
"95a0e70b-fe02-4f47-aef9-2efff279df71"
Name of the file
Example:
"payslip1.pdf"
The type of document
Example:
"Payslip"
Example:
"2019-05-17T00:00:00.000Z"
Location to download the document
Example:
"/documents/a9249254-ab10-4a2d-b709-eda95f5ecd59"
A string coming from the parameters of the uploaded payslip1.pdf either the form field name or external_document_id
header for the file part. It might not be unique and depends on what's passed when uploading.
Example:
"payslip123456"
curl --request GET \
--url https://api.sandbox.goteal.co/documents \
--header 'X-API-KEY: <api-key>'
{
"pagination": {
"offset": 75,
"limit": 25,
"count": 14,
"total_count": 89
},
"documents": [
{
"document_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
"file_name": "payslip1.pdf",
"document_external_id": "payslip123456",
"type": "Payslip",
"upload_time": "2019-05-17T00:00:00.000Z",
"file_contents": "/documents/a9249254-ab10-4a2d-b709-eda95f5ecd59"
}
]
}