Upload files, create secure links and data room access, and pull analytics into your own systems with a simple REST API.
subfolder_id, subfolder and path (“Folder › Subfolder”), /api/v2/documents takes subfolder, data room documents and index nodes carry room_folder_id.type, offer_id added).Authorization, like the endpoints under /public-api./public-api now follows the same plan rule as REST API v2: Max plan and higher (also during the trial). On other plans every endpoint answers 402 Payment Required with {"error": "…"}, the same JSON as REST API v2; on Max, Unlimited, the Deal Room Pass and the trial nothing changed. The MCP server for AI assistants stays on Pro and higher (and the trial)./public-api, as on REST API v2. GET /public-api/directory lists the folders you can open in the panel (administrators: every folder of the team).HelpRange provides API for uploading files and obtaining analytics data. The HelpRange API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
https://www.helprange.com/public-api
The API is available on the Max plan and higher (also during the trial): Max, Unlimited and the Deal Room Pass. On other plans every endpoint answers 402 with {"error": "…"}.
Authenticate your account by including your API Key in every API request. Your API key carries many privileges, so be sure to keep it secure! Do not share your API key in publicly accessible areas such GitHub, client-side code, and so forth.
Go to your account's profile. There you will find your API Key.
You need to put value of your API Key in HTTP header Authorization.
$ curl -X GET https://www.helprange.com/public-api/directory \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i'
HelpRange API uses HTTP response codes to indicate API errors.
/public-api/directory$ curl -X GET https://www.helprange.com/public-api/directory \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i'
{
"directories": [
{"id": 17, "name": "sales_documents"},
{"id": 28, "name": "marketing_documents"}
]
}
/public-api/directory/<directory_id>/file$ curl -X GET https://www.helprange.com/public-api/directory/243/file \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i'
{
"files": [
{
"id": 250,
"name": "marketing_copy.pdf",
"file_links": [
{
"id": 264,
"uuid": "471dcc98874d4d0cb7c3eb1874c4e3db",
"link": "/view/471dcc98874d4d0cb7c3eb1874c4e3db",
"name": "default"
}
]
}
]
}
/public-api/file/<file_id>/statistics$ curl -X GET https://www.helprange.com/public-api/file/124/statistics \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i'
{
"engagement_score": 11.57,
"total_views": 39,
"avg_time_seconds": 24,
"avg_time_per_page_seconds": [10, 6, 4, 9, 15, 2, 78, 73, 0, 4, 0, 0, 0, 0, 0, 82, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"recordings": [
{
"time": "2022-10-24 10:34:56",
"ip": "134.34.12.56",
"country": "US",
"referrer_url": "https://www.facebook.com",
"read_time_sec": 100
}
]
}
/public-api/directory/<directory_id>/upload/<file_name>$ curl -X POST https://www.helprange.com/public-api/directory/38/upload/filenewname.pdf \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i' \
-H 'content-type: multipart/form-data' \
-F "file=@/upload/my_sales_document.pdf;type=application/pdf"
{
"id": 260,
"default_link": "/view/8956d1e7b91b47e196a8040b1d4894f8"
}
/public-api/directory$ curl -X POST https://www.helprange.com/public-api/directory \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"name": "my directory", "onlyIpAddresses": "34.124.145.56,101.127.144.90"}'
{
"id": 260,
"link": "/view-directory/8956d1e7b91b47e196a8040b1d4894f8"
}
$ curl -X POST https://www.helprange.com/public-api/directory \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"name": "another directory", "onlyIpAddresses": null}'
{
"id": 260,
"link": "/view-directory/8956d1e7b91b47e196a8040b1d4894f8"
}
/public-api/file/<file_id>/link$ curl -X POST https://www.helprange.com/public-api/file/124/link \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{
"label": "someLabel",
"isAllowDownloadingAndPrint": true,
"isOnlyOneUserViewing": false,
"isForwardable": true,
"isScreenshotMask": false,
"isWatermark": false,
"passcode": null,
"expirationDate": null,
"viewsLimit": null
}'
{
"id": 260,
"link": "/view/8956d1e7b91b47e196a8040b1d4894f8"
}
$ curl -X POST https://www.helprange.com/public-api/file/124/link \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{
"label": "someLabel",
"isAllowDownloadingAndPrint": true,
"isOnlyOneUserViewing": false,
"isForwardable": true,
"isScreenshotMask": false,
"isWatermark": false,
"passcode": "abcd",
"expirationDate": "2024-12-24",
"viewsLimit": 10
}'
{
"id": 261,
"link": "/view/8956d1e7b91b47e1asd67a8040b1d4894f8"
}
/public-api/guest$ curl -X POST https://www.helprange.com/public-api/guest \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"email": "john@company.com"}'
{
"id": 5
}
/public-api/guest/<guest_id>/assign/<data_room_id>$ curl -X POST https://www.helprange.com/public-api/guest/7/assign/10 \
-H 'Authorization: t7ktuxyzb7emijofz9o8852i'
{
"result": "success"
}
REST API v2 is the API behind our Zapier, Make and n8n integrations, open to your own scripts as well. It works with the same API key and returns JSON; ids are the same as in the endpoints above.
https://www.helprange.com/api/v2
Send your API key in the X-API-Key header, as Authorization: Api-Key <key>, or as the bare key in Authorization. OAuth access tokens (Authorization: Bearer …) from the HelpRange MCP connector work too.
$ curl https://www.helprange.com/api/v2/data-rooms \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
REST API v2 is part of the Max and Unlimited plans, the Deal Room Pass and the trial (/me, /folders and buyer access also work on Pro). The API key acts as you, with your rights in the panel: administrators see every folder, data room and e-signature request of the team; members see the folders they belong to, the data rooms they created and the e-signature requests they created or sent. A setting your plan does not include is refused with the plan that has it. E-mails the API makes HelpRange send (signature requests, reminders, data room invitations) count towards the same daily sending limits as the panel. Offers are never e-mailed through the API: it returns the offer's link, and “Send by e-mail” stays in the panel with its explicit confirmation.
Errors come back as JSON: {"error": "…"}.
Requests are limited to 600 per hour per IP address.
/api/v2/plan$ curl https://www.helprange.com/api/v2/plan \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"plan": "Max", "plan_key": "max", "you_are_admin": true,
"features": [{"feature": "E-signature", "available": true, "plan_needed": "Pro"}],
"ai_requests": {"used": 12, "limit": 500, "left": 488, "period": "calendar month"},
"data_rooms_left": null, "mcp_server": true, "rest_api": true,
"pricing_url": "https://www.helprange.com/pricing"
}
/api/v2/documents/<document_id>$ curl https://www.helprange.com/api/v2/documents/250?recent_views=5 \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"id": 250, "name": "proposal.pdf", "type": "document", "pages": 12, "views": 39, "downloads": 2,
"total_seconds_read": 1830, "last_viewed_at": "2026-11-09T14:02:11+00:00",
"share_link": "https://www.helprange.com/view/471dcc98874d4d0cb7c3eb1874c4e3db/proposal",
"avg_seconds_per_page": [{"page": 1, "avg_seconds": 21}, {"page": 2, "avg_seconds": 64}],
"recent_views": [{"viewer": "anna@client.com", "opened_at": "2026-11-09T14:02:11+00:00", "seconds_read": 312,
"country": "DE", "downloaded": false, "document": "proposal.pdf", "document_id": 250}]
}
/api/v2/documents/<document_id>/links$ curl https://www.helprange.com/api/v2/documents/250/links \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"document": "proposal.pdf",
"links": [{"id": 264, "url": "https://www.helprange.com/view/471dcc98…/proposal", "label": "ACME – Anna",
"allow_download": false, "passcode": true, "expires_on": "2026-12-31", "views_limit": null,
"watermark": true, "require_email": true, "disallow_forwarding": false, "one_viewer_at_a_time": false}]
}
/api/v2/activity$ curl https://www.helprange.com/api/v2/activity?type=esign&limit=2 \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"events": [{"at": "2026-11-10T09:12:40+00:00", "type": "esign", "text": "anna@client.com signed “NDA”",
"detail": "", "url": "https://www.helprange.com/user/signature-doc?signatureId=…"}],
"more": true, "next_before": "2026-11-10T09:12:40.123456+00:00"
}
/api/v2/signature-requests$ curl https://www.helprange.com/api/v2/signature-requests?status=sent \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"signature_requests": [{
"id": "9f1c2e…", "title": "NDA", "status": "sent", "status_label": "Sent", "sender": "Ann Admin",
"document_id": 250, "data_room": null, "created_at": "2026-11-10T08:00:00+00:00",
"sent_at": "2026-11-10T08:00:02+00:00", "expires_at": "2026-12-10T22:59:59+00:00",
"completed_at": null, "ended_at": null, "signed": 0, "recipients_count": 2,
"url": "https://www.helprange.com/user/signature-doc?signatureId=9f1c2e…"
}]
}
/api/v2/signature-requestsA signature page with a block per signer is added at the end of the document; recipients get an e-mail with their signing link. Responds 201.
$ curl -X POST https://www.helprange.com/api/v2/signature-requests \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{
"document_id": 250,
"title": "Mutual NDA",
"signers": [{"name": "Anna Client", "email": "anna@client.com"},
{"name": "Legal", "email": "legal@client.com", "action": "review"}],
"sequential": true
}'
{"id": "9f1c2e…", "title": "Mutual NDA", "status": "sent", "signed": 0, "recipients_count": 2, "sent": true, …}
/api/v2/signature-requests/<id>$ curl https://www.helprange.com/api/v2/signature-requests/9f1c2e \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"id": "9f1c2e…", "title": "Mutual NDA", "status": "sent", "message": "", "sequential": true,
"recipients": [{"name": "Anna Client", "email": "anna@client.com", "role": "sign", "order": 1, "status": "viewed",
"status_label": "Viewed", "can_act_now": true, "completed_at": null}],
"events": [{"at": "2026-11-10T08:00:00+00:00", "kind": "created", "label": "Created", "recipient": null},
{"at": "2026-11-10T08:05:13+00:00", "kind": "opened", "label": "Opened", "recipient": "anna@client.com"}],
"signed_pdf_available": false, …
}
/api/v2/signature-requests/<id>/remindAt most once an hour per request (400 otherwise).
$ curl -X POST https://www.helprange.com/api/v2/signature-requests/9f1c2e/remind \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{}'
{"id": "9f1c2e…", "reminded": ["anna@client.com"]}
/api/v2/signature-requests/<id>/voidCannot be undone.
$ curl -X POST https://www.helprange.com/api/v2/signature-requests/9f1c2e/void \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"reason": "Wrong version"}'
{"id": "9f1c2e…", "status": "voided", …}
/api/v2/signature-requests/<id>/signed-pdfThe signed PDF carries the certificate of completion (audit trail). 409 while not everyone has signed.
$ curl https://www.helprange.com/api/v2/signature-requests/9f1c2e/signed-pdf \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"id": "9f1c2e…", "url": "https://www.helprange.com/esign/download/…/", "valid_days": 30,
"sha256": "5e88489…", "sealed": true
}
/api/v2/data-rooms$ curl https://www.helprange.com/api/v2/data-rooms \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"data_rooms": [{"id": 10, "name": "Project Falcon", "guests": 4, "documents": 37, "pending_access_requests": 1,
"expires_at": null, "frozen": false, "index_numbering": true}]
}
/api/v2/data-rooms/<data_room_id>When a room is frozen, freeze.archives lists the closing archives (ZIP with index, documents and audit report) with a download_url once ready.
$ curl https://www.helprange.com/api/v2/data-rooms/10 \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"id": 10, "name": "Project Falcon", "nda_required": "Falcon NDA", "expires_at": null,
"guests": [{"email": "buyer@bidco.com", "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}],
"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}
}
/api/v2/data-rooms/<data_room_id>/indexA folder node is either a data room folder (room_folder_id, folder_id null) or the folder the documents come from (folder_id).
$ curl https://www.helprange.com/api/v2/data-rooms/10/index \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"data_room_id": 10, "index_numbering": true,
"index": [
{"type": "folder", "number": "1", "name": "Financials", "folder_id": null, "room_folder_id": 5, "children": [
{"type": "document", "number": "1.1", "name": "pnl.xlsx", "document_id": 260, "room_link_id": 910, "room_folder_id": 5}
]},
{"type": "document", "number": "2", "name": "teaser.pdf", "document_id": 250, "room_link_id": 901, "room_folder_id": null},
{"type": "folder", "number": "3", "name": "Legal", "folder_id": 31, "children": [
{"type": "document", "number": "3.1", "name": "articles.pdf", "document_id": 252, "room_link_id": 903, "room_folder_id": null}
]}
]
}
/api/v2/data-rooms/<data_room_id>/guestsLike "Add guest" in the panel: the invitation e-mail goes out when the room sends e-mail notifications and has a document. 201 for a new guest, 200 when they already are one, 409 when the room is frozen.
$ curl -X POST https://www.helprange.com/api/v2/data-rooms/10/guests \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"email": "buyer@bidco.com"}'
{"id": 77, "email": "buyer@bidco.com", "data_room_id": 10, "invited": true, "already_a_guest": false}
/api/v2/data-rooms/<data_room_id>/access-requests$ curl https://www.helprange.com/api/v2/data-rooms/10/access-requests \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"access_requests": [{"id": 5, "data_room_id": 10, "data_room": "Project Falcon", "name": "Bob Buyer",
"email": "bob@fund.com", "company": "Fund LP", "message": "We are bidding.",
"status": "pending", "requested_at": "2026-11-10T07:00:00+00:00", "decided_at": null,
"review_url": "https://www.helprange.com/user/outside-team/10/"}]
}
/api/v2/data-rooms/<data_room_id>/signature-requests$ curl https://www.helprange.com/api/v2/data-rooms/10/signature-requests \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"data_room": "Project Falcon",
"signature_requests": [{"envelope_id": "9f1c2e…", "document": "spa.pdf", "document_id": 260, "status": "sent",
"summary": "1 of 2 signed", "sent_at": "2026-11-10T08:00:02+00:00", "due": null,
"signers": [{"email": "buyer@bidco.com", "status": "signed", "signed_at": "2026-11-10T09:00:00+00:00"}]}]
}
/api/v2/data-rooms/<data_room_id>/questions$ curl https://www.helprange.com/api/v2/data-rooms/10/questions?status=open \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"data_room_id": 10,
"questions": [{"id": 41, "number": "Q7", "status": "assigned", "status_label": "Assigned", "category": "legal",
"text": "Any pending litigation?", "source": "guest", "asked_by": "buyer@bidco.com",
"document_id": 252, "document": "articles.pdf", "index": "2.1", "page": 4,
"visibility": "private", "request_item_id": null, "assignee": "ann@acme.com",
"answer": null, "answer_approved": false, "decline_reason": null,
"asked_at": "2026-11-10T07:30:00+00:00", "answered_at": null, "approved_at": null}]
}
/api/v2/data-rooms/<data_room_id>/questionsLike importing a buyer's question list in the panel: nobody is e-mailed. Answer and approve in the panel. 201; 409 when the room is frozen.
$ curl -X POST https://www.helprange.com/api/v2/data-rooms/10/questions \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"text": "Any pending litigation?", "category": "legal", "index": "2.1", "page": 4}'
{"id": 42, "number": "Q8", "status": "new", "source": "import", "index": "2.1", …}
/api/v2/data-rooms/<data_room_id>/requests$ curl https://www.helprange.com/api/v2/data-rooms/10/requests \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"data_room_id": 10,
"request_items": [{"id": 3, "number": "1.1", "category": "Legal", "description": "Articles of association",
"priority": "high", "due_date": "2026-12-01", "assignee": "ann@acme.com", "status": "provided",
"status_label": "Provided", "documents": [{"document_id": 252, "index": "2.1"}],
"created_at": "2026-11-10T07:00:00+00:00", "updated_at": "2026-11-10T07:10:00+00:00"}]
}
/api/v2/data-rooms/<data_room_id>/requests201; 409 when the room is frozen.
$ curl -X POST https://www.helprange.com/api/v2/data-rooms/10/requests \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"description": "Articles of association", "number": "1.1", "priority": "high", "due_date": "2026-12-01", "documents": ["2.1"]}'
{"id": 3, "number": "1.1", "status": "open", "documents": [{"document_id": 252, "index": "2.1"}], …}
/api/v2/folders/<folder_id>/subfoldersSubfolders only group the documents of a folder: the folder's protection, links, members and analytics apply to them unchanged. One level – a subfolder holds documents, never other subfolders. POST the same URL with name to create one (201); POST /api/v2/subfolders/<id> with name renames it; POST /api/v2/subfolders/<id>/delete deletes the subfolder only – its documents go back to the top of the folder, nothing is deleted.
$ curl -X POST https://www.helprange.com/api/v2/folders/31/subfolders \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' --data-binary '{"name": "Contracts"}'
{
"folder_id": 31, "folder": "Legal", "subfolders_available": true, "documents_at_top": 4,
"subfolders": [{"id": 7, "name": "Contracts", "position": 0, "folder_id": 31, "documents_count": 12}]
}
/api/v2/folders/<folder_id>/subfolders/move$ curl -X POST https://www.helprange.com/api/v2/folders/31/subfolders/move \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' --data-binary '{"document_ids": [252, 253], "subfolder_id": 7}'
{"moved": 2, "folder_id": 31, "subfolder_id": 7, "subfolder": "Contracts", "not_in_folder": []}
/api/v2/data-rooms/<data_room_id>/foldersA data room folder groups the room's documents (one level); the files stay in the folders they come from, so one room folder can hold documents from many of your folders. POST the same URL with name to create one (201); POST …/folders/<folder_id> with name renames it; POST …/folders/<folder_id>/delete deletes the room folder only – its documents stay in the room, at the top level. 409 when the room is frozen.
$ curl https://www.helprange.com/api/v2/data-rooms/10/folders \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"data_room_id": 10, "data_room": "Project Falcon", "frozen": false,
"folders": [{"id": 5, "name": "Financials", "position": 0, "data_room_id": 10, "documents_count": 3}]
}
/api/v2/data-rooms/<data_room_id>/folders/move$ curl -X POST https://www.helprange.com/api/v2/data-rooms/10/folders/move \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' --data-binary '{"room_link_ids": [910, 911], "folder_id": 5}'
{"moved": 2, "data_room_id": 10, "room_folder_id": 5, "room_folder": "Financials", "not_in_room": []}
/api/v2/data-rooms/<data_room_id>/documentsLike “Add existing documents” on the room page: document_ids (up to 100) from folders you can open – not data room storage folders – optionally straight into a room folder (folder_id). The files stay in their folders. When the room sends e-mail notifications, its guests get one e-mail for the batch. 201; 409 when the room is frozen. GET the same URL lists the room's documents in index order with their room folder and the folder (and subfolder) they come from.
$ curl -X POST https://www.helprange.com/api/v2/data-rooms/10/documents \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' --data-binary '{"document_ids": [260, 261], "folder_id": 5}'
{"data_room_id": 10, "documents": [
{"room_link_id": 910, "document_id": 260, "name": "pnl.xlsx", "number": "1.1", "room_folder_id": 5,
"room_folder": "Financials", "folder_id": 44, "folder": "Finance", "subfolder_id": 9, "subfolder": "2026",
"path": "Finance › 2026"}
]}
/api/v2/offer-responses$ curl https://www.helprange.com/api/v2/offer-responses \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"responses": [{"kind": "accepted the offer", "type": "accept", "offer_id": 31, "email": "anna@client.com", "email_verified": true, "offer": "Proposal Q4",
"comment": "Let's go", "document_id": 250, "engagement": 87, "country": "DE",
"at": "2026-11-10T10:00:00+00:00"}]
}
/api/v2/offersAdministrators see every offer of the team; members the offers they created and those whose documents they can open – as in Offers in the panel.
$ curl 'https://www.helprange.com/api/v2/offers?status=active&search=acme' \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"offers": [{"id": 31, "title": "Fit-out Q1", "status": "active", "expired": false,
"client": {"first_name": "Anna", "last_name": "Nowak", "company": "Acme", "email": "anna@acme.com"},
"kind": "files", "url": "https://www.helprange.com/o/Xk2…/", "document_views": 4, "page_visits": 2,
"last_viewed_at": "2026-11-11T09:12:00+00:00", "sent_at": null, "created_at": "…", "updated_at": "…"}],
"page": 1, "limit": 50, "total": 1, "next_page": null
}
/api/v2/offersBased on a folder (folder_id – new files show up in the offer), from documents (file_ids: a JSON list, repeated form fields or "1,2"), or empty with just a title and client (upload documents later with /api/v2/files and add them). Offers without a folder get their own folder “Offer – <title>”. Responds 201 with the offer as in Offer details.
url yourself, or use “Send by e-mail” on the offer page in HelpRange – it shows the e-mail and asks you to confirm.$ curl -X POST https://www.helprange.com/api/v2/offers \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"title": "Fit-out Q1", "file_ids": [250, 251], "client_company": "Acme",
"client_email": "anna@acme.com", "access": "domain", "show_decline": true,
"passcode": "oak-41", "expires_on": "2026-12-31"}'
{"id": 31, "title": "Fit-out Q1", "status": "active", "url": "https://www.helprange.com/o/Xk2…/", …,
"send_by_email": "HelpRange does not e-mail offers through the API or MCP. …"}
/api/v2/offers/<id>Texts, client, buttons, protection, layout, its documents (each with the offer's own link and its views), visits, people, engagement and the 10 latest responses. status is what the panel shows (expired for an active offer past its date), stored_status the saved one.
$ curl https://www.helprange.com/api/v2/offers/31 \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"id": 31, "title": "Fit-out Q1", "status": "active", "stored_status": "active", "expired": false,
"url": "https://www.helprange.com/o/Xk2…/", "panel_url": "https://www.helprange.com/user/offers/31/",
"message": "…", "price_summary": "from 2,400 EUR",
"buttons": {"accept": {"shown": true, "label": ""}, "contact": {"shown": true, "label": ""},
"decline": {"shown": true, "label": ""}},
"protection": {"require_email_verification": true, "access": "domain", "allowed_emails": "anna@acme.com @acme.com",
"allow_download": false, "watermark": false, "passcode": true, "screenshot_protection": false,
"one_viewer_at_a_time": false, "expires_on": "2026-12-31"},
"open_directly": false, "layout": "classic",
"files": [{"id": 250, "name": "proposal.pdf", "folder_id": 12, "source": "picked",
"view_url": "https://www.helprange.com/view/…/proposal.pdf", "views": 3}],
"document_views": 4, "page_visits": 2, "people": 1, "engagement": 82,
"responses_count": 1, "responses": [{"type": "decline", "kind": "declined the offer", "comment": "Too expensive", …}],
"send_by_email": "HelpRange does not e-mail offers through the API or MCP. …"
}
/api/v2/offers/<id> (PATCH or POST)Changes only the fields you send (see Create an offer). The offer's links follow at once (protection, expiry, status). "status": "active" reopens an accepted, declined or archived offer. Answers with the offer.
$ curl -X PATCH https://www.helprange.com/api/v2/offers/31 \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' \
--data-binary '{"status": "active", "expires_on": "2027-01-31", "one_viewer_at_a_time": true}'
/api/v2/offers/<id>/files · /api/v2/offers/<id>/files/removefile_ids: documents from folders you can open (up to 50). Removing only takes a document out of the offer – the file stays in its folder. Answers with the offer.
$ curl -X POST https://www.helprange.com/api/v2/offers/31/files \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i' \
-H 'Content-Type: application/json' --data-binary '{"file_ids": [252]}'
/api/v2/offers/<id>/responsesEvery answer to this offer (accept, contact, decline with its reason in comment), newest first. Optional kind, days, limit as in Offer responses.
$ curl https://www.helprange.com/api/v2/offers/31/responses \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{"responses": [{"kind": "declined the offer", "type": "decline", "offer_id": 31, "email": "anna@acme.com",
"email_verified": true, "offer": "Fit-out Q1", "comment": "Too expensive", "engagement": 64,
"country": "PL", "at": "2026-11-11T10:00:00+00:00"}]}
/api/v2/store/sales$ curl https://www.helprange.com/api/v2/store/sales \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"products": [{"id": 4, "name": "Market report 2026", "kind": "folder", "price": 49.0, "currency": "EUR",
"subscription": false, "published": true, "sales": 18, "revenue": 882.0, "buyers_with_access": 18}],
"purchases": [{"product": "Market report 2026", "email": "buyer@x.com", "name": "Bo Buyer", "company": "",
"paid": "€49.00", "subscription_active": null, "at": "2026-11-10T11:00:00+00:00"}]
}
/api/v2/landing-templatesfolders: the folders (you can open) that use the form.
$ curl https://www.helprange.com/api/v2/landing-templates \
-H 'X-API-Key: t7ktuxyzb7emijofz9o8852i'
{
"landing_templates": [{"id": 8, "name": "Whitepaper gate", "title": "Get the 2026 report", "description": "",
"fields": ["email", "company"], "required_fields": ["email"],
"email_verification": true, "consent": true, "folders": [31]}]
}