Skip to Content
HelvetlyDocs
API referenceDocuments

List document folders

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
/api/v1/documents/folders

Every live folder of the workspace as a flat list ordered by name; build the tree from parent_id. Includes file counts and sizes.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/documents/folders'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "parent_id": "string",      "file_count": 0,      "size": 0,      "total_files": 0,      "total_size": 0,      "created_by": {        "id": "string",        "name": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "starred": true    }  ]}