The Klipy RESTful API allows you to build powerful, custom integrations that can read, write, and update data within your Klipy account.

This guide will walk you through the essential first steps: authenticating your requests, understanding our policies, and following best practices for a stable and secure integration.

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 account.
Navigate to Settings → API.
Click the "Generate Key" button.
Enter a descriptive name for the key (e.g., "Internal Dashboard Integration" or "Zapier Test").
Your key will be displayed. Copy this key immediately and store it in a secure location.

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 Endpoint Reference

The complete, interactive documentation for all available API endpoints, including required parameters, request examples, and response objects, is the single source of truth for our API.

Explore the official documentation at:
https://developer.klipycrm.com/api-reference

Rate Limits

To ensure the stability and performance of the API for all users, requests are rate-limited. If you send too many requests in a short period, you will receive an HTTP 429 Too Many Requests status code.

Your application should be designed to handle this gracefully. We recommend implementing a retry strategy with exponential backoff, which waits for progressively longer periods between retries to avoid overwhelming the server.

Standard rate limits apply
Status code 429 indicates you've exceeded the rate limit
Implement appropriate retry logic in your applications

Best Practices

Following these best practices will help you build a more secure, reliable, and maintainable integration.

Store API Keys Securely: Never hardcode API keys directly in your application's source code. Use a secure secret manager or environment variables to store them.
Rotate API Keys Periodically: For enhanced security, make it a practice to revoke old keys and generate new ones on a regular schedule.
Use Separate Keys for Different Environments: Use distinct API keys for your development, staging, and production environments to prevent accidental data modification.
Monitor API Usage: Keep an eye on your application's API usage and response patterns to catch potential issues early.
Implement Proper Error Handling: Your code should anticipate and handle potential API errors, including 4xx client errors and 5xx server errors, not just successful 2xx responses.