How to create an API key

A team administrator opens API keys in the left menu, gives the key a name, picks its scopes (or Read-only / Full access), chooses Live or Test (sandbox), optionally an expiry date, and clicks Create key. Copy it right away – it is shown only once.

Plan: Pro and higher (Pro, Max, Unlimited), the Deal Room Pass and the 7-day trial. See plans

Steps

  1. As a team administrator, open API keys under Settings in the left menu.
  2. Under Create a key enter a Name (e.g. CRM sync).
  3. Tick the Scopes the integration needs, or use the Read-only or Full access preset.
  4. Choose the Mode: Live for your real data or Test (sandbox) for sample data. Set Expires (optional) if you want.
  5. Click Create key and copy it – “Copy it now – it is shown only once.”
  6. Send it as Authorization: Bearer hr_live_… or X-API-Key: hr_live_…. Later use Roll key to replace it or Revoke to stop it at once.

Opens the right page in HelpRange. New to HelpRange? Sign up first – 7-day free trial, no card.

Create an API key

Who the key acts as

A key acts with the permissions of the administrator who created (or last rolled) it. If that person leaves the team, the key stops working – roll it. Older per-member keys (Legacy key (full access, live)) keep working; switch integrations to a scoped key when you can.

Test keys

Test keys (hr_test_…) only see a separate sandbox with sample documents, links and a data room. The sandbox sends no e-mails and makes no payments; Reset sandbox starts it again.

Limits and good to know

  • Up to 50 keys per team.
  • When rolling, the old key can keep working for 24 hours or 7 days, or stop at once.
  • 3,600 API requests an hour per team (at most 120 a minute), 300 write requests an hour, 2,000 new share links a day.
  • Sandbox data is deleted after 30 days.

Learn more

Updated · Checked against the current product · All help topics · FAQ