> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cardclan.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Integration API Overview

> Connect CardClan with third-party platforms and automation tools

## 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.

<Warning>
  Integration Keys are different from regular CardClan API keys. They are specifically generated for third-party integrations and automation
  platforms.
</Warning>

### 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

```bash theme={null}
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:

<CodeGroup>
  ```bash cURL theme={null}
  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": "john@example.com",
        "company": "Acme Corp"
      }]
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://app.cardclan.io/api/integration/send-card', {
    method: 'POST',
    headers: {
      Authorization: 'Bearer YOUR_INTEGRATION_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      card: 'card-id',
      integrationId: 'integration-config-id',
      mergeTags: [
        {
          name: 'John Doe',
          email: 'john@example.com',
          company: 'Acme Corp',
        },
      ],
    }),
  });

  const result = await response.json();
  ```
</CodeGroup>

## Getting Started

<Steps>
  <Step title="Generate Integration Key">Create your integration key in the CardClan dashboard</Step>
  <Step title="Test Authentication">Use the [Validate Token](/api-reference/integration/authentication/validate-token) endpoint</Step>
  <Step title="Get Your Data">Retrieve your workspaces and cards using the data endpoints</Step>
  <Step title="Set Up Integration Config">Create an integration configuration for your workflow</Step>
  <Step title="Send Your First Card">Use the [Send Card](/api-reference/integration/actions/send-card) endpoint</Step>
</Steps>