Skip to Content
HelvetlyDocs
API referenceDocuments

List who a document is shared with

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/{id}/shares

The clients the document is shared with: shared documents are visible to that client in the client portal.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The document's id.

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/documents/string/shares'
Example Response
{  "data": [    {      "client_id": "string",      "client_name": "string",      "shared_at": "2019-08-24T14:15:22Z"    }  ]}