---
title: Data room details (GET /api/v2/data-rooms/{data_room_id}) | HelpRange API
description: GET /api/v2/data-rooms/{data_room_id}: Settings, links (guest link, panel), guests (views, last visit, NDA status, their own invitation link), documents, freeze status with closing archives, and Q&A counts.
url: https://www.helprange.com/developers/api/get-data-room
---

GET

# Data room details

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

Settings, links (guest link, panel), guests (views, last visit, NDA status, their own invitation link), documents, freeze status with closing archives, and Q&A counts.

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

## 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 \
  -H "X-API-Key: $HELPRANGE_API_KEY"
```

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

```
{
  "id": 10,
  "name": "Project Falcon",
  "nda_required": "Falcon NDA",
  "folders_enabled": true,
  "settings": {
    "watermark": true,
    "download": false,
    "screenshot_protection": false,
    "notify": true,
    "expires_at": null,
    "nda": {
      "enabled": true,
      "nda_id": 4,
      "name": "Falcon NDA",
      "mode": "click"
    },
    "qa": true,
    "access_requests": false,
    "folders_enabled": true
  },
  "links": {
    "guest_link": "https://acme.helprange.com/data-room/0c6f2b9e7d1a4f3b8a5e6d7c9b0a1f2e/",
    "panel_url": "https://www.helprange.com/user/outside-team/10/",
    "owner_preview_url": "https://www.helprange.com/user/outside-team/10/preview"
  },
  "folders": [
    {
      "id": 5,
      "name": "Financials"
    }
  ],
  "approval_workflow": false,
  "guests": [
    {
      "id": 77,
      "email": "buyer@bidco.com",
      "link": "https://acme.helprange.com/view-team/0c6f2b9e7d1a4f3b8a5e6d7c9b0a1f2e/5b2e8c1d9f7a4e3b/",
      "views": 23,
      "last_view_at": "2026-11-09T17:40:00+00:00",
      "nda": "signed",
      "nda_signed_at": "2026-11-02T10:00:00+00:00"
    }
  ],
  "pending_access_requests": 1,
  "documents": [
    {
      "id": 250,
      "name": "teaser.pdf",
      "views": 11,
      "room_link_id": 901,
      "room_folder_id": null,
      "room_folder": null,
      "group": null,
      "approval": "published"
    }
  ],
  "expires_at": null,
  "index_numbering": true,
  "freeze": {
    "frozen": false,
    "guest_access": "full",
    "frozen_at": null,
    "archives": []
  },
  "qa": {
    "available": true,
    "open_questions": 3,
    "questions": 12,
    "request_items": 40,
    "guests_can_ask": true,
    "answers_need_approval": false,
    "guests_see_request_list": true
  }
}
```

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

```

```