---
title: List data rooms (GET /api/v2/data-rooms) | HelpRange API
description: GET /api/v2/data-rooms: Data rooms with guest and document counts (administrators: every room; members: the rooms they created).
url: https://www.helprange.com/developers/api/list-data-rooms
---

GET

# List data rooms

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

Data rooms with guest and document counts (administrators: every room; members: the rooms they created).

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

## Example request

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

```
const res = await fetch('https://www.helprange.com/api/v2/data-rooms', {
  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',
    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. |
| `405` | Wrong HTTP method for this endpoint. |
| `429` | A usage limit was reached – wait Retry-After seconds. |

Example response · 200

```
{
  "data_rooms": [
    {
      "id": 10,
      "name": "Project Falcon",
      "guests": 4,
      "documents": 37,
      "pending_access_requests": 1,
      "expires_at": null,
      "frozen": false,
      "index_numbering": true,
      "folders_enabled": 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

```

```