GET
/
documents
List all documents for a user.
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

​
X-API-KEY
string
header
required

Query Parameters

​
user_id
string
required

ID of the user to get documents for

​
offset
integer
default:0

The offset to start at

Required range: x >= 0
​
limit
integer
default:50

The number of items to return

Required range: 1 <= x <= 100

Response

200
application/json

Document response

The response is of type object.