Evon
Docs
API Reference

API Reference

Complete guide to the Evon Public API for integrating with your applications.

The Evon Public API provides programmatic access to manage leads, products, organizations, and more. This RESTful API uses JSON for data exchange and API keys for authentication.

Base URL

https://dev.api.evoncrm.com

For development:

http://localhost:3002

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Getting Your API Key

  1. Log into your Evon dashboard
  2. Navigate to Settings → API Keys
  3. Generate a new API key or copy an existing one

Rate Limiting

The API implements rate limiting to ensure fair usage:

  • 100 requests per minute per API key
  • Rate limit headers are included in responses

Error Handling

The API uses conventional HTTP response codes:

  • 200 - OK: Request successful
  • 201 - Created: Resource created successfully
  • 400 - Bad Request: Invalid request data
  • 401 - Unauthorized: Invalid or missing API key
  • 404 - Not Found: Resource not found
  • 409 - Conflict: Resource already exists
  • 429 - Too Many Requests: Rate limit exceeded
  • 500 - Internal Server Error: Server error

Error Response Format

{
  "error": "Error message",
  "details": "Additional error details (optional)"
}

Interactive Documentation

For testing endpoints interactively, visit our Swagger UI:

Quick Start

Here's a simple example to get you started:

curl -X GET "https://dev.api.evoncrm.com/organization" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

Continue reading the specific endpoint documentation below for detailed usage instructions.

DependenciesAuthentication