API
Manage your organization's API keys for programmatic access to Yaplet and integration with external services.
What is an API Key?
An API key is a secure token that provides full access to your Yaplet organization's data and features. It's required for all API calls and should be kept secure.
Key Points
- Organization-level: Your organization can have up to 10 named keys, shared across your team — all of them work at the same time
- One-time display: A key's secret is shown only once, when it is created - save it immediately
- Full access: Every key provides complete access to your account data through Yaplet's APIs. Whether an AI app may use the key is a separate setting, AI access (MCP), which starts off
- On every plan: API keys are part of the free base — you do not need a paid plan to create one
Managing Your API Keys
Go to Settings → Connections → MCP & API keys. The page has two parts: Connect an AI app at the top (see Connecting an AI app below) and your API keys underneath, with a line such as 3 of 10 keys used. Each key has its own row showing its name, its ending (yAPI_… plus the last 6 characters of the secret, so you can match a key against the one in your config), when it was created, when it was last used, and its AI access (MCP) setting. A key with AI access switched on also carries an AI access on badge. The ⋯ (More actions) menu at the end of the row holds Delete.
Last used shows when a request last arrived with the key. Every request carrying it counts, even one Yaplet then refused. It updates at most every 15 minutes, so for a busy key the time can be up to 15 minutes old. A key with no recorded use shows No use recorded yet.
Creating a Key
- Click New API key (or the same button in the No API keys yet message, if you have none)
- Give the key a name describing what it will be used for — e.g. Production server (required), then click Create key
- Copy and save the secret immediately with the Copy button in the Your new API key window - it cannot be retrieved again; Yaplet only stores a hash of it
- Keys are prefixed with
yAPI_for easy identification
Deleting a Key
Open the key's ⋯ menu and choose Delete. Yaplet asks you to type the key's name to confirm. The key stops working immediately and cannot be restored — anything still using it will fail.
To swap a key without downtime: create a new key, switch your integration over to it, then delete the old one.
yAPI_… — their ending was never stored.Using Your API Key
Include any of your API keys in the Y-API-Key header for all API requests:
Y-API-Key: yAPI_your_generated_key_here
API Use Cases
Your API keys enable various integrations such as:
- Affiliate tracking - Record referrals and commissions
- Newsletter subscriber management - Bulk import and update contacts
- Email automation triggers - Start an email automation for a contact programmatically
- Custom integrations - Connect Yaplet with your existing systems
Connecting an AI app
The top of the MCP & API keys page, Connect an AI app, shows how to connect Claude Desktop, Claude Code, Cursor, VS Code or Windsurf to Yaplet through MCP. Pick your app and the page shows that app's own steps, with the Server URL and the settings to copy.
- Normally you sign in with your browser and no API key is needed.
- If browser sign-in doesn't work (common with Cursor), switch on Use an API key instead. The steps change to the key version. Create a key in the list below and switch its AI access on first.
- Full setup guide opens the complete MCP guide.
- AI apps work on every paid plan and during your free 14 days. Without either, the page shows a Connecting AI apps needs a plan notice with a See the options button. Your API keys stay, and they keep working for the regular API.
AI access (MCP)
An API key is also one of the ways an AI app connects to your account through the MCP server. The AI access (MCP) setting in each key's row decides, key by key, whether that is allowed and how much the AI may do:
| Setting | What an AI app using this key may do |
|---|---|
| Off | Nothing — the AI app is refused. The key keeps working for Yaplet's other APIs. |
| Read only | Look things up. It changes nothing. |
| Read and change | Also create and update things that can be changed back. |
| Read, change, delete and send | Also delete a record for good, or send a message to someone outside your team. |
- New keys start Off. Switch AI access on only for a key you actually use with an AI app.
- A key runs as the person who switched it on. The AI can then do only what that person may do in the dashboard right now. The row shows who it runs as — Runs as …. If that person is disabled, the key's AI access stops until they are re-enabled; if they are removed from the organization, it stops for good — the row then says Runs as a removed member, and since only a key's creator can switch it on, the organization owner creates a new key instead.
- Only the key's creator can switch its AI access on or change its level, so nobody can turn a colleague's key into an AI key that runs as them. Switching it Off is up to the key's creator or the organization owner, so nobody can cut off the AI app on a colleague's key either. On a key you can't change, the setting is grayed out and says who can. For keys created before creators were recorded, only the organization owner can switch it on.
- Older keys: keys that existed before this setting kept full AI access and run as the organization owner (Runs as the organization owner). If you don't use such a key with an AI app, switch its AI access off.
- Every change of this setting is written to the Audit Log as API key AI access changed, and every change an AI makes through the key is logged there with the key's name.
Security
- Store keys securely (environment variables, secret managers)
- Never commit keys to version control
- To replace a key, create a new one, switch your integration over, then delete the old key
- Limit access to necessary team members