All 63 operations of the HelpRange REST API – files, share links, data rooms, Q&A, e-signature, offers and analytics – with parameters, response examples, code in curl, JavaScript and Python, and a console to try each call with your own API key.
https://www.helprange.com/api/v2Create a team API key in Settings → API keys and send it as Authorization: Bearer hr_live_… (X-API-Key and Authorization: Api-Key <key> work too). Each key has scopes – every operation below names the one it needs – and keys starting with hr_test_ work on a sandbox with sample data that never sends e-mail. The legacy key on your profile page and OAuth access tokens of the HelpRange MCP connector keep full access. The older /public-api endpoints take the key in Authorization. Keep keys on your server, never in client-side code or a public repository.
curl https://www.helprange.com/api/v2/me -H "Authorization: Bearer $HELPRANGE_API_KEY"Plans: the REST API is part of the Max and Unlimited plans, the Deal Room Pass and the trial; Who is connected, List folders and buyer access also work on Pro. Other plans get 402 with {"error": "…"}.
Errors come back as JSON {"error": "…"}, some with a machine-readable code (v1: {"status", "message"}).
| Status | Meaning |
|---|---|
400 | A parameter is missing or invalid – the message says which. |
401 | Missing or invalid API key / OAuth token (team keys: invalid_key, key_revoked, key_expired, key_owner_removed). |
402 | Your plan does not include the REST API (or this feature). |
403 | The key lacks the scope this endpoint needs: {"code": "insufficient_scope", "required_scope"}. |
404 | Not found – or not yours; the API never says which. |
409 | The data room is frozen, or the signed PDF is not ready yet. |
413 | The file is over the upload limit. |
429 | A usage limit was reached: {"error", "code", "retry_after"} and a Retry-After header. |
Counted per team – all API keys and connected AI apps of a team share them – in clock hours and minutes (UTC). Every authenticated response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.
| Requests per team | 3,600 an hour, 120 a minute |
| Write requests per team | 300 an hour |
| Share links / guests created through the API | 2,000 / 1,000 a day |
| E-mails to other people caused by API requests | 100 an hour, 500 a day, at most 50 recipients per request |
| Requests per IP address | 4,000 an hour (60 with a missing or invalid key) |
| Failed requests per team | more than 300 in an hour pause the team's API for 15 minutes |
Who is connected, the plan and its limits.
Folders and their subfolders.
Uploads, documents, statistics and share links.
Polling triggers for Zapier, Make and n8n: newest first, each item with a stable id.
Data rooms, their index, guests, folders, documents, Q&A and request lists.
Send documents for e-signature, follow them and download the signed PDF.
Offers with their own link; the API never e-mails the client.
Store sales and buyer access to product folders.
Lead magnet / landing page forms.
The team activity feed.
The original /public-api endpoints. They keep working; new integrations should use REST API v2.
The OpenAPI 3.1 file works with Postman, Insomnia and code generators. AI assistants connect through the MCP server (OAuth, no API key) – see Build with AI; the whole reference as Markdown for LLMs: llms-full.txt. The older single-page API documentation lists what changed and when.