canonical: https://jentic.com/apis/cardclan.io/cardclan

# CardClan Integration API

The CardClan Integration API lets applications and automation platforms send personalized digital cards and drive card workflows from existing systems. It sends cards through a connected email account, generates shareable card URLs, lists the cards and workspaces available to a user, and reads the details of a specific card. Integration configurations tie cards into automated workflows, and an integration key authenticates each request.

## For AI agents

Send personalized digital cards through a connected email account, generate shareable card links, and read cards, workspaces, and card details. Integration configurations drive automated card workflows.

## Scope

Does not handle SMS, physical mail, or payment processing. Use for sending digital cards and managing card workflows only.

## Capabilities

- Send a personalized digital card to a recipient through a connected email account
- Generate a shareable URL for a card
- List the cards and workspaces available to a user
- Read the details of a specific card by its id
- Create and read integration configurations that drive card workflows
- Generate an integration key to authenticate automation against CardClan

## Use cases

### Agent-sent personalized cards

An AI agent handling customer touchpoints can send a personalized digital card at the right moment, choosing a card from the user's workspace and sending it through a connected email account. Because the CardClan Integration API also returns a shareable card URL, the agent can include the link in a follow-up message rather than only emailing it.

Example prompt: Send a personalized card from a workspace to a recipient through a connected email account and confirm it was sent

### Milestone and engagement automation

Teams that send cards on customer milestones can wire the trigger to CardClan so a card goes out automatically. The API lists workspace cards, sends the chosen card through an email account, and reads which cards already have workflows attached, so an automation sends the right card without manual steps.

Example prompt: List the cards that have workflows attached, then send the matching card for a customer milestone

### Card workflow configuration

Before automating sends, an integrator sets up how cards map to a workflow. The CardClan Integration API creates and reads integration configurations, including the configuration tied to a specific card, so the setup is defined once and then reused by every send. An integration key authenticates the automation.

Example prompt: Generate an integration key, then create an integration configuration that maps a card to a workflow

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/integration/send-card` | Send a personalized card through a connected email account |
| POST | `/integration/get-card-url` | Get a shareable URL for a card |
| POST | `/integration/cards` | List the cards available to a user |
| GET | `/integration/workspaces` | List a user's workspaces |
| GET | `/integration/email-accounts` | List the connected email accounts |
| GET | `/integration/card-details/{cardId}` | Read the details of a specific card |
| POST | `/integration/auth/create-key` | Generate an integration key |

## Key resources

- **Cards** — List user cards, read card details, and generate shareable card URLs
- **Send card** — Send a personalized card through a connected email account
- **Workspaces and email accounts** — List the workspaces and email accounts available to a user
- **Integration config** — Create and read configurations that drive card workflows, and generate integration keys

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 45 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 72 / 100
  - AI-Readiness & Agent Experience: 19 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 82 / 100
- **View full report:** https://jentic.com/apis/cardclan.io/cardclan/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the CardClan Integration API by hand means handling its bearer-token auth, generating an integration key from a Firebase token, and connecting an email account before you can send anything. Through Jentic you install once, import CardClan from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The card and recipient travel in the request body, not the URL path, so a rule bounds which operations your agent may call rather than which card it sends. You choose the operations it may call, such as sending cards and listing workspaces, so integration key generation or config changes are not included unless you add them.
- **Credential handling:** Your CardClan integration key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a digital card' or 'generate a card link', and Jentic returns the matching CardClan operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Resend** — Resend sends transactional email directly, where CardClan sends designed digital cards through connected accounts.
- **Mailjet** — Mailjet handles transactional and marketing email at scale, where CardClan focuses on card sends and workflows.
- **Mailchimp** — Mailchimp runs the broader marketing campaign around the cards CardClan sends.

## FAQ

### What authentication does the CardClan Integration API use?

The CardClan Integration API authenticates with a bearer token: your CardClan integration key for integration calls, and a Firebase ID token sent as a bearer token to generate a key, as declared in its OpenAPI spec. Through Jentic the key is stored once and injected at call time, so it never appears in your agent's prompt or logs.

### Can I get a shareable link for a card with the CardClan Integration API?

Yes. Alongside sending a card through a connected email account, the API returns a shareable card URL, so an agent can include the link in a chat message or other channel instead of only sending the card by email.

### What are the rate limits for the CardClan Integration API?

The OpenAPI spec does not state numeric rate limits for the CardClan Integration API. Check the vendor documentation at https://docs.cardclan.io for current limits before sending cards at volume.

### How do I send a card through Jentic with the CardClan Integration API?

Search Jentic for 'send a digital card', which returns the POST `/integration/send-card` operation with its input schema, then call it with the card and recipient. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the CardClan Integration API?

Yes. Write a rule that allows only the send-card and list operations, so the agent can send cards and read workspaces but cannot generate integration keys or change configurations, and every call it makes is logged. The card and recipient travel in the request body, so the rule bounds which operations run rather than which card is sent.