Klipy CRM provides a RESTful API that allows you to programmatically interact with your CRM data. This documentation will guide you through authentication and basic usage of the API.
Important Notice
⚠️ Beta Release: The Klipy API is currently in open beta. Please note:
No Service Level Agreement (SLA) is provided during the beta period
API operations are not reversible - please use with caution
Test thoroughly in a non-production environment first
API specifications may change without prior notice
Authentication
All API requests require authentication using an API key in the header.
API Key Management
Obtaining an API Key
Log in to your Klipy CRM account
Navigate to Settings → API (Link)
Click "Generate Key"
Enter the name of the key (e.g. Zapier Test)
Using Your API Key
Include your API key in all API requests using the following header:
X-KLIPY-API-KEY: klipy_pk_<your_api_key_here>
Revoking an API Key
Log in to your Klipy CRM account
Navigate to Settings → API (Link)
Find the API key you want to revoke
Click "Remove"
Verifying Your API Key
Test your API key by making a GET request to the authentication endpoint:
curl --request GET \ --url https://api.klipycrm.com/api/v1/authenticate \ --header 'X-KLIPY-API-KEY: your_api_key_here'
Successful response:
{ "team_name": "Your_Team_Name" }
API Documentation
Complete API documentation is available at:
https://developer.klipycrm.com/api-reference
Rate Limits
Standard rate limits apply
Status code 429 indicates you've exceeded the rate limit
Implement appropriate retry logic in your applications
Best Practices
Store API keys securely
Rotate API keys periodically
Use separate API keys for different environments
Monitor API usage and response patterns
Implement proper error handling
Test thoroughly before production use