Create & Manage Your API Key

Connect your own tools to your Discovered hiring data with a personal API key.

Overview

The Discovered User API lets your spreadsheets, reporting tools, scripts and internal systems work with your hiring data without anyone signing in to Discovered. Each user gets a personal API key on My Profile. Your developer or IT team uses that key to connect a tool to Discovered.

With your API key, a connected tool can:

  • Read your jobs, candidates, candidate details and hiring pipeline.
  • Read the report data you can already see in Discovered.
  • Make changes, but only where your role allows them.

Your key works with your permissions. It can only see the companies, jobs and departments you can see in Discovered, and it can never do more than your role allows.

Note: This feature must be enabled by a Discovered administrator before it becomes available on an account. If you don't see the API Key card on My Profile, contact your account representative.

Before You Start

  • Your company must have the User API turned on by the Discovered team.
  • You need an Admin, Editor or Viewer role in the company. To check your role, see Manage User Roles & Permissions.
  • Open My Profile while you're working in a single company. The API Key card doesn't appear when you're viewing your company group.
  • Have a safe place ready to store the key, such as your company's password manager.

How to Create & Manage Your API Key:

1. Open the API Key Card

  • Click your name in the top navigation bar.
  • Select My Profile from the dropdown menu.
  • Find the API Key card. If your account uses the older profile layout, look for the API key section instead. It has the same icons and options.
  • With no key yet, the card shows No key preview.

Tip: The PhoneBurner card next to it can also show No key preview. Make sure you're looking at the card titled API Key.

2. Generate Your Key

  • Click the plus icon (Generate key) next to No key preview.
  • The Your API key window opens with your full key.

3. Copy and Store Your Key

  • Click the copy button next to the key. The tooltip changes to Copied.
  • Paste the key into your password manager or give it straight to the person setting up your integration.
  • Click Done to close the window.

Important: This is the only time Discovered shows your full key. After you close the window, you'll only see its last four characters. If you lose the key, you'll need to replace it (step 5).

After you close the window, the card shows your key's last four characters, the date it was Created and when it was Last used. Last used shows never until the key is first used. It updates when you reload the page.

Discovered also emails you whenever a key is created or replaced. If you get this email and didn't make the change, replace or revoke the key and change your password.

4. Open the API Documentation

  • Click API documentation on the API Key card. It opens in a new tab.
  • The page lists everything a connected tool can do with the API. It is for reading only, so you can't send requests from it.
  • Click Download OpenAPI file to save the full description of the API as a file your developer can import into their tools.

Note: The documentation is only available to signed-in users whose User API access is turned on.

5. Replace Your Key (If Needed)

Replace your key if you've lost it or think someone else might have it.

  • Click the sync icon (Replace key) on the API Key card.
  • In the Replace API key? window, click Replace.
  • Copy and store the new key, then click Done.

Important: Your old key stops working right away. Update every tool that uses it with the new key.

6. Revoke Your Key (If Needed)

Revoke your key when you no longer need it, for example when you stop using an integration.

  • Click the red trash icon (Revoke key) on the API Key card.
  • In the Revoke API key? window, click Revoke.
  • Requests that use the key are refused right away. The card goes back to No key preview, and you can generate a new key at any time.

What Your Key Can Access

  • One key for all your companies: If you belong to several companies, the same key works in each company where your User API access is turned on.
  • Same access as you: Admins can read the whole company. Editors and Viewers can read only the jobs and departments assigned to them. Viewers can't make changes.
  • Access can change: If the Discovered team turns off API access for your company or for you, your key stops working there immediately. It starts working again if access is turned back on.
  • One key per person: Each user has their own key. Nobody, including Admins, can see or manage another user's key.

Why This Matters

The User API puts your hiring data to work in the tools your team already uses. You can:

  • Stop exporting and re-entering data by hand.
  • Build your own dashboards and reports from live hiring data.
  • Connect Discovered to internal systems on your own schedule.
  • Keep data secure, because every key follows the same permissions as its owner.

Use Cases

  • Reporting Teams: Pull job and candidate data into a BI tool or spreadsheet for weekly hiring reports.
  • Operations Teams: Check a candidate's status or pipeline progress from an internal system.
  • IT and Developers: Build a custom integration between Discovered and your HR or payroll software.

Best Practices

  • Store your key in a password manager. Never share it by email or chat, or paste it into a document.
  • Replace your key right away if you think someone else has seen it.
  • Revoke keys you no longer use.

What Happens Next

  • Your developer uses the key and the API documentation to connect your tool to Discovered.
  • Check Last used on the API Key card to see when your key was last used.
  • For automatic updates whenever something happens in Discovered, such as a candidate being hired, see Webhooks & Event Tracking.
  • To ask Claude, ChatGPT or another AI tool about your hiring data without a key, see Connect AI Tools to Discovered.

With a personal API key, you can connect your own tools to Discovered securely, using the same access you already have.