Skip to content
Help CenterPlatform · Settings

API Keys

Manage API credentials and integration access, and open or download the API reference.

Updated Oct 12, 2026 6 steps 9 questions answeredOpen this page in the platform
On this page

Overview

API Keys manages deal-scoped credentials for the selected client's SalesHive Platform API access. An eligible client can keep up to 10 active named keys, use a separate key for each integration, review usage, replace or revoke one key without disturbing the others, and retain revoked credentials in the audit history. API authentication works only while the client is active and in the Onboarding or Active pipeline. Full key values are shown only once when they are created or replaced.

How to use this page

  1. Check the selected client and access state

    Confirm the client in the Client Switcher. The header shows whether API access is Enabled or Suspended, the client's effective pipeline, active-key count, authenticated request total, most recent use, and revoked-key count. Copy the Base URL, https://app.saleshive.com/api/public/v1, when an integration asks for the API endpoint.

  2. Open or download the API reference

    In the API documentation panel below the access summary, select View documentation to open the public reference in a new tab. Select Download PDF to save SalesHive-Platform-API.pdf with endpoints, authentication guidance, and both cURL and JavaScript examples. Wait while the button says Preparing PDF. If the download fails, try again. The meeting.added and meeting.updated event reference includes personState for the prospect and companyState for the company. Unknown values are null, and older recorded events may omit these fields.

  3. Save the default key or add an integration key

    Opening API Keys for an eligible client with no active credentials creates a Default API Key automatically and displays its full value once. Copy and store that value before leaving or refreshing. To add another credential, enter a descriptive name such as Reporting Integration and select Add API key. Use a separate named key for each connection. A client can have up to 10 active keys.

  4. Review usage or rename a key

    Each Active Keys row shows the name, masked value, created time, last use, and authenticated request count. The Default badge identifies the original primary credential. Select Rename to edit a label, then Save or Cancel. Renaming changes only the label, not the secret or integration access.

  5. Replace one connected key

    Select Replace on the exact integration key that needs a new secret. Review the confirmation, then select Replace key. The old key stops working immediately, the replacement keeps the same name and Default designation when applicable, and its full value appears once. Copy it and update the connected system before leaving the page.

  6. Revoke keys and understand suspension

    Select Revoke and confirm when a key should stop authenticating without a replacement. The credential moves to Key History and cannot be used again. If the client leaves the Onboarding or Active pipeline, or is archived, API authentication is suspended and Add API key and Replace are unavailable. Existing unrevoked keys stay in the audit trail and work again if the client returns to an eligible pipeline.

What the buttons do

View documentation
Opens the public SalesHive Platform API reference in a new tab from the API documentation panel.
Download PDF
Saves the complete API reference as SalesHive-Platform-API.pdf. The button is unavailable while the PDF is being prepared; a failed download shows a message asking you to try again.
Copy (base URL)
Copies https://app.saleshive.com/api/public/v1 for use as the integration's API endpoint.
Copy API key
Copies the full newly created or replacement secret while it is shown. SalesHive cannot display that full value again.
Add API key
Creates another named credential for the selected eligible client, up to 10 active keys.
Rename
Opens one key's name for editing without changing its secret.
Save
Saves the edited key name.
Cancel
Closes a rename editor or confirmation without applying the action.
Replace
Opens a confirmation for replacing the selected key with a new one-time secret.
Replace key
Confirms replacement. The selected old key stops working immediately and moves to Key History.
Revoke
Asks for confirmation, then disables the selected key without creating a replacement.

Common questions

No. Active rows show only a masked value. If the full value was not saved, select Replace on that specific key, confirm the immediate replacement, and copy the newly displayed secret before leaving the page.
Yes. A client can have up to 10 active keys. Give each integration its own named key so one connection can be replaced or revoked without interrupting the others.
When an eligible client has no active credentials, opening API Keys creates the first credential automatically and marks it Default. Later named keys are independent credentials for additional integrations.
The selected client is archived or is not currently in the Onboarding or Active pipeline. Requests are rejected, and new or replacement keys are unavailable until the client becomes eligible again.
Yes. Each API key allows 600 requests per minute. Past that, the API returns 429 rate_limited with a Retry-After header, so wait that many seconds and try again. Give each integration its own key so one busy connection does not slow the others.
Yes. Active keys that were not revoked remain in the audit trail and can authenticate again when the client is unarchived and returns to the Onboarding or Active pipeline. Revoked keys never become active again.
Replace disables one selected key immediately and issues a new secret with the same name. Revoke disables the selected key without issuing a replacement. Both preserve the old masked credential in Key History.
No. Revoking stops that credential from authenticating and retains its audit record. It does not delete the client's data.
API keys for connecting your own systems come with the managed service. Self-serve workspaces do not see API Keys in the sidebar, and opening its address shows Not on your plan.
More in Settings
Blacklist Client Billing CRM Connection Detail Custom Fields
Still stuck?

Get an answer from a real person

These guides cover the everyday questions. For anything they miss, we are easy to reach.

Talk now

Let’s talk about your sales goals

Ask SalesHive AI about our services, pricing and how we can help your team grow.

Talk to SalesHive AI

Talk right here. No appointment needed.