> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stardex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Keys

> Create scoped API keys, choose permissions, set expiration dates, and roll or revoke existing keys.

API keys let you securely connect your workspace to outside tools — Zapier, sourcing tools, reporting dashboards, and custom integrations. Every key can be given exactly the access it needs, so you never have to hand over more than necessary.

<img src="https://mintcdn.com/stardex/3qUa0wFvl8G0ygpK/images/help-center/api-keys/settings-api-keys-28.png?fit=max&auto=format&n=3qUa0wFvl8G0ygpK&q=85&s=c0ca310d1d7d456e1e618126837c03d5" alt="API keys list on Email & other integrations → API access & Webhooks" width="2120" height="1126" data-path="images/help-center/api-keys/settings-api-keys-28.png" />

API keys list on Email & other integrations → API access & Webhooks

***

## Who can manage API keys

Only **organization admins** can create, roll, or revoke API keys. If you don't see these options, ask an admin in your workspace.

## Where to find them

Go to **Settings → Email & other integrations → API access & Webhooks**: [stardex.com/settings?tab=email-calendar\&section=api-access](https://stardex.com/settings?tab=email-calendar\&section=api-access)

Webhooks for outbound events are on this same page, below the keys. See the [Webhooks](/help-center/webhooks) guide.

***

## Creating an API key

1. Click **Create key**.
2. Give it a clear **name** (for example, “Zapier integration” or “Reporting dashboard”). Use a separate key for each tool so they're easy to manage.
3. Choose an **access level** (see below).
4. *(Optional)* Set an **expiry date**.
5. Click **Create key**.

### Access levels

| Level | What it can do | Best for |
| - | - | - |
| **Read only** | Read data across your workspace, but can't change anything. | Reporting, dashboards, and syncing data out. |
| **Integration** | Read and write People, Candidates, and Jobs, and write notes and activities. No access to documents, note history, compensation, deals, or meetings. | Zapier and sourcing tools. |
| **Custom** | Exactly the permissions you choose. | Fine-grained control. |
| **Admin** | Full access to everything, including sensitive data. | Only when nothing narrower works. You'll be asked to type **ADMIN** to confirm. |

***

## Choosing permissions (Custom keys)

When you pick **Custom**, you'll see a grid of resources with **Read**, **Write**, and **Delete** columns. Tick only what the integration actually needs.

* **Read** — view data
* **Write** — create and update data
* **Delete** — remove data

Some resources are marked **Sensitive** (Documents, Notes & activities, Compensation, and Meetings & recordings). Only grant these when the integration truly requires them.

Resources you can control include People, Documents, Notes & activities, Compensation, Candidates, Jobs, Companies & contacts, Deals, Tasks, Scorecards, Lists, Meetings & recordings, Reports, Workspace metadata, and Webhooks.

***

## Copying and storing your key

Right after you create a key, it's shown to you **once**. Copy it and store it somewhere safe — your password manager, or directly in the tool you're connecting.

For your security, the full key is never shown again. If you lose it, just **roll** the key to get a new one.

***

## Setting an expiry (optional)

By default, keys **never expire**. If you'd like a key to stop working automatically on a certain date — handy for temporary access or contractors — set an expiry date when creating it.

***

## Managing your keys

The keys table shows every key in your workspace:

* **Name** — what you called it
* **Key** — the first few characters, so you can tell keys apart
* **Access** — a summary of its permissions (hover to see the full list)
* **Status** — **Active**, **Inactive**, **Revoked**, or **Expired**

Open the **⋯** menu on any key to see when it was **created**, when it was **last used**, and when it **expires**.

***

## Rolling and revoking keys

From the **⋯** menu on a key:

* **Roll key** — Creates a new key with the **same access** and turns off the old one. Use this if a key may have been exposed, or on a regular schedule for good security hygiene. You'll need to update your tool with the new key.
* **Revoke** — Turns the key off **immediately and permanently**. Any tool using it stops working right away. Use this when a key is no longer needed.

Both actions can't be undone — rolling won't bring back the old key.

***

## Already using an API key?

Your existing API key **still works**, so your current integrations won't break. We recommend replacing it with a new **scoped** key that has only the access it needs, then revoking the old one. This gives you tighter security and clearer control over each integration.

***

## Tips

* Give each integration its own key with a clear name.
* Use the **narrowest access that gets the job done** — start with Read only or Integration before reaching for Custom or Admin.
* **Roll** keys periodically, and immediately if one may have leaked.
* Set an **expiry** for anything temporary.

## Related guides

* [Webhooks](/help-center/webhooks)
* [Zapier setup](/help-center/zapier-setup)
* [Connecting Metaview to Stardex](/help-center/connecting-metaview-to-stardex)
* [Email & other integrations](/help-center/email-other-integrations)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.