---
title: v1: List files in a directory (GET /public-api/directory/{directory_id}/file) | HelpRange API
description: GET /public-api/directory/{directory_id}/file: Documents of a folder with their links.
url: https://www.helprange.com/developers/api/v1-list-files
---

GET

# v1: List files in a directory

`https://www.helprange.com/public-api/directory/{directory_id}/file`

Documents of a folder with their links.

**Plans:** Pro, Max, Unlimited, Deal Room Pass, trial. **Auth:** the API key in `Authorization` (bare, or `Bearer hr_live_…`) (v1). **Scope:** `documents:read`. **Operation id:** `v1ListFiles`

## Parameters

| Name | In | Type | Description |
|---|---|---|---|
| `directory_id` required | path | integer | Folder id. (min 1) |

## Example request

```
curl -X GET https://www.helprange.com/public-api/directory/243/file \
  -H "Authorization: $HELPRANGE_API_KEY"
```

```
const res = await fetch('https://www.helprange.com/public-api/directory/243/file', {
  method: 'GET',
  headers: {'Authorization': 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/public-api/directory/243/file',
    headers={'Authorization': 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` | v1: the key is invalid, or the folder / file / guest / data room is not yours (HTML page unless you send Accept: application/json). Team keys (v1 and v2): code insufficient_scope with required_scope – the key lacks the scope this endpoint needs. |
| `429` | A usage limit was reached – wait Retry-After seconds. |

Example response · 200

```
{
  "files": [
    {
      "id": 250,
      "name": "marketing_copy.pdf",
      "file_links": [
        {
          "id": 264,
          "uuid": "471dcc98874d4d0cb7c3eb1874c4e3db",
          "link": "/view/471dcc98874d4d0cb7c3eb1874c4e3db",
          "name": "default"
        }
      ]
    }
  ]
}
```

## 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

directory_id (path, required)

```

```
