API Keys
All API requests require authentication using a workspace API key. Keys are scoped to your workspace and can only access your own data.Key Format
API keys start with thewbk_ prefix (workspace key):
Creating an API Key
- Go to Dashboard → Settings → API & Integrations
- Click Create API Key
- Configure:
- Name: Descriptive name for the key
- Permissions: Select read, write, and/or Lexi access
- Expiration: Optional expiry date
- Save the key immediately — you won’t see it again!
Making Authenticated Requests
Include your API key in theAuthorization header using Bearer authentication:
Example
Permissions
API keys can have three types of permissions:Read
Read
View contacts, lists, campaigns, deals, and prospect search results.Endpoints:
GET /v1/contactsGET /v1/listsGET /v1/campaigns- All GET endpoints
Write
Write
Create, update, and delete contacts, lists, and campaigns.Endpoints:
POST /v1/contactsPATCH /v1/contacts/:idPOST /v1/listsPOST /v1/campaigns- All POST, PATCH, DELETE endpoints
Lexi AI
Lexi AI
Interact with Lexi AI assistant, view and approve tasks.Endpoints:
POST /v1/lexi/chatGET /v1/lexi/tasksPOST /v1/lexi/tasks/:id/approve
Rate Limits
API usage is limited based on your workspace plan:| Plan | Daily Limit | Per Minute |
|---|---|---|
| Starter | 100 calls | 10 |
| Pro | 1,000 calls | 50 |
| Org | 10,000 calls | 200 |
Rate limits reset at midnight UTC (00:00).
Rate Limit Headers
Every API response includes headers showing your current usage:When You Hit the Limit
If you exceed your rate limit, you’ll receive a429 Too Many Requests error:
429 Too Many Requests
Error Responses
Authentication Errors
Missing Authorization Header
401 Unauthorized
Invalid API Key
401 Unauthorized
Revoked Key
401 Unauthorized
Insufficient Permissions
403 Forbidden
Key Management
Rotating Keys
To rotate an API key:- Create a new key with the same permissions
- Update your application to use the new key
- Test thoroughly to ensure the new key works
- Revoke the old key in the dashboard
Monitoring Usage
View API usage statistics in your dashboard:- Total calls today
- Calls per endpoint
- Error rate
- Last used timestamp
Best Practices
Use Environment Variables
Store API keys in environment variables, never in code:
Rotate Regularly
Rotate keys every 90 days or when team members leave
Minimal Permissions
Only grant permissions that are actually needed
Monitor Activity
Check “Last Used” regularly to detect unused or leaked keys
Workspace Isolation
API keys are workspace-scoped. Each key can only access data within its own workspace. There is no cross-workspace access.
- You can only view/edit your own contacts
- You can only create campaigns for your own lists
- Lexi AI only has access to your workspace data