API referenceDocuments
List documents
Needs a token with the read:documents scope (or write:documents). Authentication
Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.
GET
Document metadata (name, size, kind, links), paged.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
page?integerPage number, from 1.
Range
1 <= valueDefault
1page_size?integerItems per page.
Range
1 <= value <= 500Default
100search?stringMatches the name.
folder_id?stringA folder id, or root for the top level; empty for all.
client_id?stringOnly documents linked to this client.
kind?stringFile kind.
Value in
"pdf""image""spreadsheet""document""presentation""text""archive"from?stringUploaded on or after.
Format
dateto?stringUploaded on or before.
Format
datesort?stringOne of name, size, created_at, updated_at, kind; prefix - for descending. Default name.
OK
application/json- response
data*array<>meta*Paging of a list: page/page_size in, totals out.
curl -X GET 'https://app.helvetly.com/api/v1/documents'Example Response
{ "data": [ { "id": "string", "name": "string", "folder_id": "string", "folder": { "id": "string", "name": "string" }, "size": 0, "content_type": "string", "kind": "pdf", "previewable": true, "sha256": "string", "links": [ { "type": "string", "id": "string", "label": "string", "retains": true } ], "retained_until": "2019-08-24", "uploaded_by": { "id": "string", "name": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deleted_by": { "id": "string", "name": "string" }, "purge_at": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "page_size": 0, "total": 0, "total_pages": 0 }}