https://www.helprange.com/api/v2/data-rooms/{data_room_id}/guestsGuests of the room with their id, e-mail and own invitation link.
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: listDataRoomGuests
| Name | In | Type | Description |
|---|---|---|---|
data_room_id required | path | integer | Data room id (from List data rooms). (min 1) |
curl -X GET https://www.helprange.com/api/v2/data-rooms/10/guests \
-H "X-API-Key: $HELPRANGE_API_KEY"const res = await fetch('https://www.helprange.com/api/v2/data-rooms/10/guests', {
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/guests',
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.
| 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. |
{
"data_room_id": 10,
"guests": [
{
"id": 77,
"email": "buyer@bidco.com",
"link": "https://acme.helprange.com/view-team/0c6f2b9e7d1a4f3b8a5e6d7c9b0a1f2e/5b2e8c1d9f7a4e3b/"
}
]
}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.