API | Yaplet

What is an API Key?

Your 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: One key per organization, shared across your team
One-time display: Keys are shown only once when generated - save them immediately
Full access: Keys provide complete access to your account data

Managing Your API Key

Generating a Key

Go to Settings → Organization settings → API (the screen itself is headed API Settings)
Click "Generate API Key"
Copy and save the key immediately - it cannot be retrieved again
Keys are prefixed with yAPI_ for easy identification

Key Management

Re-generate API Key: Creates a new key (old one becomes invalid)
Delete API Key: Removes API access entirely

Regenerating or deleting your key will break existing integrations. Update all applications with the new key.

Using Your API Key

Include your API key in the Y-API-Key header for all API requests:

Y-API-Key: yAPI_your_generated_key_here

API Use Cases

Your API key enables 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

Detailed API documentation for each endpoint is available on their respective documentation pages:

The same key connects an MCP client

This key is also how an MCP client authenticates against Yaplet. A connection made with an API key acts as the organization owner, with access to every enabled tool category — which is the strongest reason on this page to keep the key secret.

Security

Security best practices:

Store keys securely (environment variables, secret managers)
Never commit keys to version control
Rotate keys regularly
Limit access to necessary team members