---
title: List share links of a document (GET /api/v2/documents/{file_id}/links) | HelpRange API
description: GET /api/v2/documents/{file_id}/links: Every share link of a document with its settings.
url: https://www.helprange.com/developers/api/list-document-links
---

GET

# List share links of a document

`https://www.helprange.com/api/v2/documents/{file_id}/links`

Every share link of a document with its settings.

**Plans:** Pro, Max, Unlimited, Deal Room Pass, trial. **Auth:** `Authorization: Bearer hr_live_…` (team key), `X-API-Key`, `Authorization: Api-Key <key>` or an OAuth `Bearer` token. **Scope:** `links:read`. **Operation id:** `listDocumentLinks`

## Parameters

| Name | In | Type | Description |
|---|---|---|---|
| `file_id` required | path | integer | Document id (from List documents). (min 1) |

## Example request

```
curl -X GET https://www.helprange.com/api/v2/documents/250/links \
  -H "X-API-Key: $HELPRANGE_API_KEY"
```

```
const res = await fetch('https://www.helprange.com/api/v2/documents/250/links', {
  method: 'GET',
  headers: {'X-API-Key': process.env.HELPRANGE_API_KEY},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${data.error || data.message || data.reason}`);
console.log(data);
```

```
import os

import requests

r = requests.get(
    'https://www.helprange.com/api/v2/documents/250/links',
    headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
    timeout=60,
)
r.raise_for_status()
print(r.json())
```

The samples read the key from the `HELPRANGE_API_KEY` environment variable.

## Responses

| Status | Description |
|---|---|
| `200` | OK |
| `401` | Missing or invalid API key / OAuth token. Team keys: code invalid_key, key_revoked, key_expired or key_owner_removed. |
| `402` | Your plan does not include the REST API (the Free plan) or this feature (e.g. NDA needs Max). |
| `403` | The team API key lacks the scope this endpoint needs. |
| `404` | Not found – or not yours (the API never says which). |
| `405` | Wrong HTTP method for this endpoint. |
| `429` | A usage limit was reached – wait Retry-After seconds. |

Example response · 200

```
{
  "document": "proposal.pdf",
  "links": [
    {
      "id": 264,
      "url": "https://www.helprange.com/view/8956d1e7b91b47e196a8040b1d4894f8/proposal.pdf",
      "label": "ACME - Anna",
      "allow_download": false,
      "passcode": true,
      "expires_on": "2026-12-31",
      "views_limit": null,
      "watermark": true,
      "require_email": true,
      "disallow_forwarding": false,
      "one_viewer_at_a_time": false
    }
  ]
}
```

## Try it

**Uses your real account.** The request goes from your browser straight to `www.helprange.com` with your API key and acts as you. The key stays in this page (in this tab's session storage only if you tick the box), is never put in a URL and is not sent to analytics. Do not paste a key on a shared computer.
 API key

  Remember in this tab

file_id (path, required)

```

```