# HelpRange API

> HelpRange is secure document sharing and virtual data rooms: upload documents, create tracked and protected share links, run data rooms (guests, NDA, Q&A, request lists), send documents for e-signature and read page-by-page analytics. Developers use the REST API (team API keys with scopes and a test-mode sandbox), signed webhooks, and a remote MCP server with OAuth for AI assistants.

Base URL: https://www.helprange.com/api/v2 (older endpoints: https://www.helprange.com/public-api). Auth: `Authorization: Bearer hr_live_…` (team API key, Settings → API keys; `hr_test_…` = sandbox). MCP server: https://www.helprange.com/mcp (Streamable HTTP, OAuth 2.1).

## Docs

- [Full API, webhooks and MCP reference as Markdown](https://www.helprange.com/developers/llms-full.txt): everything below in one file
- [OpenAPI 3.1 document](https://www.helprange.com/developers/openapi.json): every operation, schema, scope and webhook
- [API reference](https://www.helprange.com/developers/api): one page per operation with curl, JavaScript and Python samples
- [API keys, scopes and sandbox](https://www.helprange.com/developers/keys)
- [Webhooks](https://www.helprange.com/developers/webhooks): events, signature verification, retries, delivery log
- [Build with AI](https://www.helprange.com/developers/ai): connect Claude, Cursor, VS Code and other MCP clients; agent framework examples
- [Recipes](https://www.helprange.com/developers/recipes): end-to-end examples with prompts and code
- [AGENTS.md section](https://www.helprange.com/developers/agents.md): drop-in instructions for coding agents
- [Developer hub](https://www.helprange.com/developers)

## REST API operations

- [Who is connected](https://www.helprange.com/developers/api/get-me): `GET /api/v2/me` (scope `team:read`)
- [Plan, features and limits](https://www.helprange.com/developers/api/get-plan): `GET /api/v2/plan` (scope `team:read`)
- [List folders](https://www.helprange.com/developers/api/list-folders): `GET /api/v2/folders` (scope `documents:read`)
- [Get a folder](https://www.helprange.com/developers/api/get-folder): `GET /api/v2/folders/{folder_id}` (scope `documents:read`)
- [Turn subfolders on or off](https://www.helprange.com/developers/api/set-folder-subfolders): `POST /api/v2/folders/{folder_id}` (scope `documents:write`)
- [List subfolders](https://www.helprange.com/developers/api/list-subfolders): `GET /api/v2/folders/{folder_id}/subfolders` (scope `documents:read`)
- [Create a subfolder](https://www.helprange.com/developers/api/create-subfolder): `POST /api/v2/folders/{folder_id}/subfolders` (scope `documents:write`)
- [Move documents to a subfolder](https://www.helprange.com/developers/api/move-documents-to-subfolder): `POST /api/v2/folders/{folder_id}/subfolders/move` (scope `documents:write`)
- [Rename a subfolder](https://www.helprange.com/developers/api/rename-subfolder): `POST /api/v2/subfolders/{subfolder_id}` (scope `documents:write`)
- [Delete a subfolder](https://www.helprange.com/developers/api/delete-subfolder): `POST /api/v2/subfolders/{subfolder_id}/delete` (scope `documents:write`)
- [List documents](https://www.helprange.com/developers/api/list-documents): `GET /api/v2/documents` (scope `documents:read`)
- [Upload a file](https://www.helprange.com/developers/api/upload-file): `POST /api/v2/files` (scope `documents:write`)
- [Create a share link](https://www.helprange.com/developers/api/create-link): `POST /api/v2/files/{file_id}/links` (scope `links:write`)
- [Document statistics](https://www.helprange.com/developers/api/get-document): `GET /api/v2/documents/{file_id}` (scope `documents:read`)
- [List share links of a document](https://www.helprange.com/developers/api/list-document-links): `GET /api/v2/documents/{file_id}/links` (scope `links:read`)
- [Recent document views](https://www.helprange.com/developers/api/list-recent-views): `GET /api/v2/views` (scope `analytics:read`)
- [Recent client uploads](https://www.helprange.com/developers/api/list-recent-uploads): `GET /api/v2/uploads` (scope `documents:read`)
- [Give a buyer access](https://www.helprange.com/developers/api/grant-buyer-access): `POST /api/v2/folders/{folder_id}/buyers` (scope `links:write`)
- [Remove a buyer's access](https://www.helprange.com/developers/api/revoke-buyer-access): `POST /api/v2/folders/{folder_id}/buyers/remove` (scope `links:write`)
- [Store products and sales](https://www.helprange.com/developers/api/list-store-sales): `GET /api/v2/store/sales` (scope `analytics:read`)
- [List lead magnet forms](https://www.helprange.com/developers/api/list-landing-templates): `GET /api/v2/landing-templates` (scope `links:read`)
- [Team activity](https://www.helprange.com/developers/api/list-activity): `GET /api/v2/activity` (scope `analytics:read`)
- [List e-signature requests](https://www.helprange.com/developers/api/list-signature-requests): `GET /api/v2/signature-requests` (scope `documents:read`)
- [Send a document for e-signature](https://www.helprange.com/developers/api/create-signature-request): `POST /api/v2/signature-requests` (scope `documents:write`)
- [E-signature request details](https://www.helprange.com/developers/api/get-signature-request): `GET /api/v2/signature-requests/{envelope_id}` (scope `documents:read`)
- [Remind signers](https://www.helprange.com/developers/api/remind-signature-request): `POST /api/v2/signature-requests/{envelope_id}/remind` (scope `documents:write`)
- [Void an e-signature request](https://www.helprange.com/developers/api/void-signature-request): `POST /api/v2/signature-requests/{envelope_id}/void` (scope `documents:write`)
- [Signed PDF link](https://www.helprange.com/developers/api/get-signed-pdf): `GET /api/v2/signature-requests/{envelope_id}/signed-pdf` (scope `documents:read`)
- [List data rooms](https://www.helprange.com/developers/api/list-data-rooms): `GET /api/v2/data-rooms` (scope `rooms:read`)
- [Data room details](https://www.helprange.com/developers/api/get-data-room): `GET /api/v2/data-rooms/{data_room_id}` (scope `rooms:read`)
- [Turn data room folders on or off](https://www.helprange.com/developers/api/set-data-room-folders): `POST /api/v2/data-rooms/{data_room_id}` (scope `rooms:write`)
- [Data room index](https://www.helprange.com/developers/api/get-data-room-index): `GET /api/v2/data-rooms/{data_room_id}/index` (scope `rooms:read`)
- [Invite a guest](https://www.helprange.com/developers/api/invite-data-room-guest): `POST /api/v2/data-rooms/{data_room_id}/guests` (scope `rooms:write`)
- [Access requests](https://www.helprange.com/developers/api/list-data-room-access-requests): `GET /api/v2/data-rooms/{data_room_id}/access-requests` (scope `rooms:read`)
- [Data room signature requests](https://www.helprange.com/developers/api/list-data-room-signature-requests): `GET /api/v2/data-rooms/{data_room_id}/signature-requests` (scope `rooms:read`)
- [List Q&A questions](https://www.helprange.com/developers/api/list-data-room-questions): `GET /api/v2/data-rooms/{data_room_id}/questions` (scope `rooms:read`)
- [Add a Q&A question](https://www.helprange.com/developers/api/add-data-room-question): `POST /api/v2/data-rooms/{data_room_id}/questions` (scope `rooms:write`)
- [List due diligence request items](https://www.helprange.com/developers/api/list-data-room-request-items): `GET /api/v2/data-rooms/{data_room_id}/requests` (scope `rooms:read`)
- [Add a request list item](https://www.helprange.com/developers/api/add-data-room-request-item): `POST /api/v2/data-rooms/{data_room_id}/requests` (scope `rooms:write`)
- [List data room folders](https://www.helprange.com/developers/api/list-data-room-folders): `GET /api/v2/data-rooms/{data_room_id}/folders` (scope `rooms:read`)
- [Create a data room folder](https://www.helprange.com/developers/api/create-data-room-folder): `POST /api/v2/data-rooms/{data_room_id}/folders` (scope `rooms:write`)
- [Move data room documents](https://www.helprange.com/developers/api/move-data-room-documents): `POST /api/v2/data-rooms/{data_room_id}/folders/move` (scope `rooms:write`)
- [Rename a data room folder](https://www.helprange.com/developers/api/rename-data-room-folder): `POST /api/v2/data-rooms/{data_room_id}/folders/{folder_id}` (scope `rooms:write`)
- [Delete a data room folder](https://www.helprange.com/developers/api/delete-data-room-folder): `POST /api/v2/data-rooms/{data_room_id}/folders/{folder_id}/delete` (scope `rooms:write`)
- [List data room documents](https://www.helprange.com/developers/api/list-data-room-documents): `GET /api/v2/data-rooms/{data_room_id}/documents` (scope `rooms:read`)
- [Add documents to a data room](https://www.helprange.com/developers/api/add-data-room-documents): `POST /api/v2/data-rooms/{data_room_id}/documents` (scope `rooms:write`)
- [List offers](https://www.helprange.com/developers/api/list-offers): `GET /api/v2/offers` (scope `links:read`)
- [Create an offer](https://www.helprange.com/developers/api/create-offer): `POST /api/v2/offers` (scope `links:write`)
- [Offer details](https://www.helprange.com/developers/api/get-offer): `GET /api/v2/offers/{offer_id}` (scope `links:read`)
- [Update an offer](https://www.helprange.com/developers/api/update-offer): `PATCH /api/v2/offers/{offer_id}` (scope `links:write`)
- [Update an offer (POST)](https://www.helprange.com/developers/api/update-offer-post): `POST /api/v2/offers/{offer_id}` (scope `links:write`)
- [Add documents to an offer](https://www.helprange.com/developers/api/add-offer-files): `POST /api/v2/offers/{offer_id}/files` (scope `links:write`)
- [Remove documents from an offer](https://www.helprange.com/developers/api/remove-offer-files): `POST /api/v2/offers/{offer_id}/files/remove` (scope `links:write`)
- [Responses to an offer](https://www.helprange.com/developers/api/list-responses-of-offer): `GET /api/v2/offers/{offer_id}/responses` (scope `analytics:read`)
- [Offer responses](https://www.helprange.com/developers/api/list-offer-responses): `GET /api/v2/offer-responses` (scope `analytics:read`)
- [v1: List directories](https://www.helprange.com/developers/api/v1-list-directories): `GET /public-api/directory` (scope `documents:read`)
- [v1: Create a directory](https://www.helprange.com/developers/api/v1-create-directory): `POST /public-api/directory` (scope `documents:write`)
- [v1: List files in a directory](https://www.helprange.com/developers/api/v1-list-files): `GET /public-api/directory/{directory_id}/file` (scope `documents:read`)
- [v1: Upload a file to a directory](https://www.helprange.com/developers/api/v1-upload-file): `POST /public-api/directory/{directory_id}/upload/{filename}` (scope `documents:write`)
- [v1: File statistics](https://www.helprange.com/developers/api/v1-file-statistics): `GET /public-api/file/{file_id}/statistics` (scope `analytics:read`)
- [v1: Create a link](https://www.helprange.com/developers/api/v1-create-link): `POST /public-api/file/{file_id}/link` (scope `links:write`)
- [v1: Add a guest](https://www.helprange.com/developers/api/v1-create-guest): `POST /public-api/guest` (scope `rooms:write`)
- [v1: Assign a guest to a data room](https://www.helprange.com/developers/api/v1-assign-guest): `POST /public-api/guest/{guest_id}/assign/{data_room_id}` (scope `rooms:write`)

## MCP tools

Server: https://www.helprange.com/mcp

- `list_folders` – List folders
- `list_documents` – List documents
- `get_document_stats` – Document statistics
- `list_recent_views` – Recent views
- `get_document_text` – Read a document
- `search` – Search documents
- `fetch` – Fetch a document
- `list_activity` – Team activity
- `get_plan` – Plan and limits
- `list_data_rooms` – List data rooms
- `get_data_room` – Data room activity
- `list_access_requests` – Data room access requests
- `list_room_signature_requests` – Data room signature requests
- `list_signature_requests` – List e-signature requests
- `get_signature_request` – E-signature request details
- `create_signature_request` – Send a document for e-signature
- `remind_signature_request` – Remind signers
- `void_signature_request` – Void an e-signature request
- `get_signed_pdf_link` – Signed PDF link
- `list_offer_responses` – Offer responses
- `list_store_sales` – Store sales
- `get_store` – Store overview
- `list_store_buyers` – Store buyers
- `upload_file` – Upload a file
- `create_link` – Create a share link
- `list_links` – List share links
- `list_offers` – List offers
- `get_offer` – Offer details
- `create_offer` – Create an offer
- `update_offer` – Update an offer
- `add_offer_files` – Add documents to an offer
- `remove_offer_files` – Remove documents from an offer
- `list_subfolders` – List subfolders
- `set_subfolders_enabled` – Turn subfolders on or off
- `create_subfolder` – Create a subfolder
- `rename_subfolder` – Rename a subfolder
- `delete_subfolder` – Delete a subfolder
- `move_documents_to_subfolder` – Move documents to a subfolder
- `list_room_folders` – List data room folders
- `set_room_folders_enabled` – Turn data room folders on or off
- `create_room_folder` – Create a data room folder
- `rename_room_folder` – Rename a data room folder
- `delete_room_folder` – Delete a data room folder
- `move_room_documents` – Move data room documents
- `add_room_documents` – Add documents to a data room

## Optional

- [HelpRange product facts](https://www.helprange.com/llms.txt): plans, prices and features
- [MCP server setup](https://www.helprange.com/mcp-server)