Skip to main content

​
What is the Integration API?

The CardClan Integration API enables third-party platforms, automation tools, and custom applications to programmatically send personalized cards, manage workflows, and integrate CardClan’s functionality into existing systems. This API is specifically designed for:
  • Automation platforms (Pabbly Connect, Zapier)
  • CRM integrations (HubSpot, Salesforce, Pipedrive)
  • E-commerce platforms (Shopify, WooCommerce)
  • Custom applications

​
Authentication

The Integration API uses Integration Keys for authentication - these are special UUID-based keys that provide scoped access to integration endpoints.
Integration Keys are different from regular CardClan API keys. They are specifically generated for third-party integrations and automation platforms.

​
How to Get Your Integration Key

  1. Log in to your CardClan dashboard
  2. Navigate to the Settings page
  3. Click “Generate Integration Key”
  4. Copy and securely store the key

​
Authentication Format

Authorization: Bearer YOUR_INTEGRATION_KEY

​
API Endpoints

The Integration API provides the following endpoint categories:

​
Authentication Endpoints

  • Validate Token - Test your integration key

​
Data Retrieval Endpoints

  • Get Workspaces - Retrieve accessible workspaces
  • Get Cards - List cards within workspaces
  • Get Email Accounts - Fetch configured email accounts

​
Action Endpoints

  • Send Card - Send personalized cards via email
  • Get Card URL - Generate shareable card URLs

​
Configuration Endpoints

  • Create Config - Set up integration configurations
  • Get Config - Retrieve integration settings

​
Workflow Management

  • Workflow Cards - Manage cards with active integrations

​
Base URL

All Integration API endpoints use: 
https://app.cardclan.io/api/integration

​
Quick Example

Here’s a simple example of sending a card using the Integration API: 
curl -X POST "https://app.cardclan.io/api/integration/send-card" \
  -H "Authorization: Bearer YOUR_INTEGRATION_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "card": "card-id",
    "integrationId": "integration-config-id", 
    "mergeTags": [{
      "name": "John Doe",
      "email": "[email protected]",
      "company": "Acme Corp"
    }]
  }'

​
Getting Started

1

Generate Integration Key

Create your integration key in the CardClan dashboard
2

Test Authentication

Use the Validate Token endpoint
3

Get Your Data

Retrieve your workspaces and cards using the data endpoints
4

Set Up Integration Config

Create an integration configuration for your workflow
5

Send Your First Card

Use the Send Card endpoint