Skip to Content
HelvetlyDocs
API referenceClients

Download a client file

Needs a token with the read:clients scope (or write:clients). 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/clients/{id}/files/{file_id}

Downloads the file. By default answers 302 with a Location header pointing to a presigned URL valid for 5 minutes; when the server streams downloads (S3_PROXY_DOWNLOADS) it answers 200 with the file bytes and the file's content type. Follow the redirect without the Authorization header. Read-only.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The client's id.

file_id*string

The file's id.

Response Body

The file bytes (only when the server streams downloads).

response?fileapplication/octet-stream
Formatbinary
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/clients/string/files/string'
Example Response
"string"

Upload files to a client

Previous Page

Delete a client file

Next Page