---
title: v1: List directories (GET /public-api/directory) | HelpRange API
description: GET /public-api/directory: Folders you can open in the panel (administrators: every folder of the team).
url: https://www.helprange.com/developers/api/v1-list-directories
---

GET

# v1: List directories

`https://www.helprange.com/public-api/directory`

Folders you can open in the panel (administrators: every folder of the team).

**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:** `v1ListDirectories`

## Example request

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

```
const res = await fetch('https://www.helprange.com/public-api/directory', {
  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',
    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

```
{
  "directories": [
    {
      "id": 17,
      "name": "sales_documents"
    },
    {
      "id": 28,
      "name": "marketing_documents"
    }
  ]
}
```

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

```

```