List uploaded documents

List user-uploaded documents by filter type.

GET /api/v1/documents

List uploaded documents

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/documents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/documents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "documents": [
    {
      "id": "<string>",
      "name": "<string>",
      "originName": "<string>",
      "link": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "content": {}
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Query Parameters

doc_type · string · default: uploaded

Document filter type, e.g. 'uploaded'

Response

200

application/json

Successful Response

Response for user-uploaded documents list.

documents · DocumentDraftInfo · object[] · required

Show child attributes