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

# Get Card URL

> Generates a personalized card URL without sending an email

Generates a personalized card URL without sending an email. This is useful when you want to share card links through channels other than email, such as SMS, social media, or direct messaging platforms.

## Key Differences from Send Card

* **No Email Delivery**: Creates a URL instead of sending an email
* **Same Personalization**: Uses merge tags to personalize the card content
* **Flexible Distribution**: You can share the URL through any channel
* **Analytics Tracking**: Still provides tracking capabilities through the URL

## Request Parameters

<ParamField body="card" type="string" required>
  The ID of the card for which to generate a URL
</ParamField>

<ParamField body="integrationId" type="string" required>
  Integration configuration ID that links to your workflow settings
</ParamField>

<ParamField body="mergeTags" type="array" required>
  Array containing recipient data for personalization. Must include at least one object with recipient information.
</ParamField>

## Response Details

<ResponseField name="view_card_url" type="string">
  Direct URL to view the personalized card
</ResponseField>

<ResponseField name="white_label_app_name" type="string">
  The app name shown in the card (usually "CardClan" unless white-labeled)
</ResponseField>

<ResponseField name="card_cover" type="string">
  URL to the card's cover image/thumbnail
</ResponseField>

<ResponseField name="unsubscribe_link_url" type="string">
  URL for recipients to unsubscribe from future cards
</ResponseField>

## Response Example

```json theme={null}
{
  "view_card_url": "https://app.cardclan.io/view/card/abc123def456?token=xyz789",
  "white_label_app_name": "CardClan",
  "card_cover": "https://cdn.cardclan.io/cards/covers/60f7b2b5b8f4a20015a4f5a5.png",
  "unsubscribe_link_url": "https://app.cardclan.io/unsubscribe?email=john@example.com&token=unsubscribe123"
}
```


## OpenAPI

````yaml POST /integration/get-card-url
openapi: 3.1.0
info:
  title: CardClan Integration API
  description: >-
    The CardClan Integration API enables third-party applications and automation
    platforms to send personalized digital cards, manage workflows, and
    integrate CardClan's functionality into existing systems.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://app.cardclan.io/api
security:
  - bearerAuth: []
paths:
  /integration/get-card-url:
    post:
      tags:
        - Actions
      summary: Get Card URL
      description: Generates a personalized card URL without sending an email
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCardUrlRequest'
      responses:
        '201':
          description: Card URL generated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCardUrlResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GetCardUrlRequest:
      type: object
      required:
        - card
        - integrationId
        - mergeTags
      properties:
        card:
          type: string
          description: Card ID for URL generation
          example: 60f7b2b5b8f4a20015a4f5a5
        integrationId:
          type: string
          description: Integration configuration ID
          example: 60f7b2b5b8f4a20015a4f5a7
        mergeTags:
          type: array
          description: Array of merge tag objects with recipient data
          items:
            $ref: '#/components/schemas/MergeTags'
          minItems: 1
    GetCardUrlResponse:
      type: object
      properties:
        view_card_url:
          type: string
          example: https://cardclan.com/view/60f7b2b5b8f4a20015a4f5a8
        white_label_app_name:
          type: string
          example: CardClan
        card_cover:
          type: string
          example: https://cdn.cardclan.com/covers/card-cover.jpg
        unsubscribe_link_url:
          type: string
          example: https://cardclan.com/unsubscribe/60f7b2b5b8f4a20015a4f5a8
    Error:
      type: object
      properties:
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Card ID is required
        statusCode:
          type: number
          example: 400
        timestamp:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
    MergeTags:
      type: object
      required:
        - name
        - email
      properties:
        name:
          type: string
          description: Recipient's full name
          example: John Doe
        email:
          type: string
          format: email
          description: Recipient's email address
          example: john@example.com
        company:
          type: string
          description: Company name
          example: Acme Corp
        position:
          type: string
          description: Job title/position
          example: Marketing Manager
      additionalProperties:
        type: string
        description: Additional custom merge tag fields
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Enter your CardClan integration key

````