← Knowledge Base/Integrations

How to Use the Vedain CRM API

Vedain CRM·18-Jun-2026·4 min read

The Vedain REST API lets you read and write CRM data programmatically — sync leads from your own app, pull contact lists into custom tools, or build integrations not available out of the box.

Generating an API Key

  1. Go to Settings → API Keys.
  2. Click Generate New Key.
  3. Enter a label (e.g., 'My Integration', 'Zapier Backup').
  4. Click Create.
  5. Copy the key immediately — it is shown only once. Store it securely.
Settings API Keys page showing Generate New Key button
Settings API Keys page showing Generate New Key button

Authentication

All API requests must include your API key in the request header:

  • Header name: X-API-Key
  • Value: your-api-key-here
  • Base URL: https://vedain.com/api/v1

Common Endpoints

  • GET /api/v1/leads — List leads (supports ?limit=50&page=1 pagination)
  • POST /api/v1/leads — Create a new lead (send JSON body with firstName, lastName, email, phone, etc.)
  • GET /api/v1/leads/{id} — Get a specific lead
  • PUT /api/v1/leads/{id} — Update a lead
  • GET /api/v1/contacts — List contacts
  • POST /api/v1/contacts — Create a contact
  • GET /api/v1/deals — List deals

Example: Creating a Lead via API

  • Method: POST
  • URL: https://vedain.com/api/v1/leads
  • Headers: X-API-Key: your-key, Content-Type: application/json
  • Body: {"firstName": "John", "lastName": "Smith", "email": "john@example.com", "phone": "9876543210", "leadSource": "API"}
API key management page with active keys and last used dates
API key management page with active keys and last used dates

Frequently Asked Questions

Where is the full API documentation?

Full API documentation is available at vedain.com/api/docs (or contact support for the latest API reference). It lists every endpoint, required and optional fields, and example requests and responses.

Is there a rate limit on API calls?

Yes. The default rate limit is 1,000 requests per minute per API key. If you need higher limits for bulk operations, contact Vedain support.

Can I use the API to bulk-import data?

Yes. Use the POST /api/v1/leads endpoint in a loop to create records programmatically. For very large datasets (10,000+ records), the CSV import in Settings → Import is faster and more reliable.

Ready to put this into practice?

Start your free 14-day trial of Vedain CRM — no credit card needed.

Start Free Trial

Still have questions?

Our support team is happy to help. Reach out any time.

Contact Support →