Browse docs

API keys

Create an API key so your own tools can call the ReacherPro API — copy it once, set an expiry, rename or revoke it, and find the API reference.

Updated

On this page

An API key lets your own tools — a script, a data warehouse sync, an internal dashboard — work with your ReacherPro workspace through the API. You create keys in Settings > API & Webhooks, and the API reference on the same page explains every endpoint.

How it works

  1. You create a key and give it a name, and an expiry date if you want one.
  2. ReacherPro shows the full key once. You copy it and store it somewhere safe.
  3. Your tool sends the key with each API request, as the API reference describes.
  4. When a key is no longer needed — or may have leaked — you revoke it and it stops working immediately.

Important: Treat an API key like a password. Anyone who has it can use the API as your workspace. Keep it on a server or in a secrets manager, never in a browser, an email or a public repository.

Open the page

  1. In the sidebar, click Settings.
  2. Open the API & Webhooks tab.
The Settings link in the sidebar and the API & Webhooks tab highlighted.
Steps 1 and 2: Settings is pinned at the bottom of the sidebar; API & Webhooks is one of its tabs.
Area What it's for
API reference Endpoints, authentication and payloads. Open reference opens it in a new tab.
API keys Every key in the workspace, with a count next to the title, and Create API key.
Webhooks Endpoints that receive events from ReacherPro. See Webhooks.

Find the API reference

  1. On the API reference card, click Open reference. The reference opens in a new browser tab.
The API reference card with Open reference highlighted.
Step 1: the reference covers endpoints, authentication and payloads.

Use the reference for the exact address to call, how to send your key with each request, and what every request and response looks like.

Create a key

  1. On the API keys card, click Create API key.
The API keys card with the Create API key button highlighted.
Step 1: Create API key is at the top right of the API keys card.
  1. Enter a Key name.
  2. Optionally, pick a date in Expires on.
Field What it does Example
Key name Required. A label so you can tell keys apart later. Name it after the tool that will use it. CRM sync, Internal dashboard
Expires on Optional. The key stops working after this date. Leave it empty for a key that never expires. The date can't be in the past, and it can't be changed later. 31/12/2026
The Create API key form with Key name and Expires on highlighted.
Steps 2 and 3: name the key and, if you want, set an expiry date.
  1. Click Create key.
The Create key button highlighted in the Create API key form.
Step 4: Create key generates the key.
  1. In API key created, click Copy and paste the key into your tool or secrets manager. The button changes to Copied.
  2. Click I've saved it.

Warning: Copy this key now — it is shown once and cannot be retrieved again. The API key created window only closes from I've saved it, so you can't lose the key with a stray click. If you close it without copying, revoke that key and create a new one.

Read the keys table

  1. A key you've just created shows its full value, hidden behind dots, with an eye to show it and a copy button. The copy button ticks and its tooltip reads Copied for a moment. Older keys only show the start of the key, like rp_Qm7c2e… — hover it to see The full key is shown once, when it is created.
  2. The other columns show where each key stands.
A key row with the hidden key value and its Last used time highlighted.
1: the key itself. 2: when an app last used it.
Column What it shows
Key The name, and the start of the key so you can match it to the one your tool uses.
Status Active — the key works. Expired — its expiry date has passed. Revoked — it was revoked and no longer works.
Last used How long ago the key last called the API, or Never used. Hover for the exact time.
Created The date the key was created.
Expires The expiry date, or No expiry. A date in red has already passed.

Tip: A key that says Never used long after you created it is probably not needed. Revoke keys you don't use.

Rename or revoke a key

  1. Click the ⋮ menu at the end of the key's row, then choose Rename or Revoke key.
The key row menu with Rename and Revoke key.
Step 1: the row menu has Rename and Revoke key.
  • Rename opens Rename API key. Only the name changes; the key itself stays the same, so nothing that uses it breaks. Click Save name — you'll see Key renamed.
  1. Revoke key asks Revoke this API key? — the key stops working immediately, and anything calling the API with it will start failing. Click Revoke key to confirm, or Cancel.
The Revoke this API key? confirmation with Cancel and Revoke key.
Step 2: revoking can't be undone — the key stops working at once.

You'll see Key revoked — That key can no longer call the API.

Replace a key without downtime

  1. Create a new key and copy it.
  2. Update your tool to use the new key and check it works — its Last used updates.
  3. Revoke the old key.

Common problems

What you see What it means What to do
Give the key a name. Key name is empty. Enter a name.
Could not save the API key. Please try again. The key wasn't created or renamed. Try again.
The key was created, but the API did not return its secret. Create a new one if you need the value. The key exists, but its value can't be shown. Revoke it and create a new key.
Could not revoke the API key. Please try again. The key still works. Try again from the row menu.
You lost a key's value Keys are only shown once. Create a new key, switch your tool to it, then revoke the old one.
Your tool's requests fail The key is Expired or Revoked, or isn't being sent the way the reference describes. Check the key's Status, then check your requests against the API reference.
Create API key is greyed out with a tooltip Your role can't create keys. Ask a workspace admin to update your role.
There's no API reference card The reference link isn't set up for your workspace. Contact ReacherPro support for the API reference.

Next: Get events pushed to you as they happen with Webhooks, or connect your CRM in CRM integrations.