---
title: Data room index (GET /api/v2/data-rooms/{data_room_id}/index) | HelpRange API
description: GET /api/v2/data-rooms/{data_room_id}/index: The room's numbered index (1, 1.1 …) in the structure guests see – always one level of folders.
url: https://www.helprange.com/developers/api/get-data-room-index
---

GET

# Data room index

`https://www.helprange.com/api/v2/data-rooms/{data_room_id}/index`

The room's numbered index (1, 1.1 …) in the structure guests see – always one level of folders. With room folders on, folder nodes are the room's folders (room_folder_id); otherwise, with "Show Folders" on, the folder the documents come from (folder_id, plus subfolder_id for "Folder / Subfolder"). The numbers exist even while numbering is off for guests (index_numbering false).

**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:** `rooms:read`. **Operation id:** `getDataRoomIndex`

## Parameters

| Name | In | Type | Description |
|---|---|---|---|
| `data_room_id` required | path | integer | Data room id (from List data rooms). (min 1) |

## Example request

```
curl -X GET https://www.helprange.com/api/v2/data-rooms/10/index \
  -H "X-API-Key: $HELPRANGE_API_KEY"
```

```
const res = await fetch('https://www.helprange.com/api/v2/data-rooms/10/index', {
  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/data-rooms/10/index',
    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

```
{
  "data_room_id": 10,
  "index_numbering": true,
  "index": [
    {
      "type": "folder",
      "number": "1",
      "name": "Financials",
      "folder_id": null,
      "room_folder_id": 5,
      "children": [
        {
          "type": "document",
          "number": "1.1",
          "name": "pnl.xlsx",
          "document_id": 260,
          "room_link_id": 910,
          "room_folder_id": 5
        }
      ]
    },
    {
      "type": "document",
      "number": "2",
      "name": "teaser.pdf",
      "document_id": 250,
      "room_link_id": 901,
      "room_folder_id": null
    }
  ]
}
```

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

data_room_id (path, required)

```

```