Skip to main content
GET
/
integration
/
config
Get Integration Configuration
curl --request GET \
  --url https://app.cardclan.io/api/integration/config \
  --header 'Authorization: Bearer <token>'
[
  {
    "key": "items",
    "cardId": "60f7b2b5b8f4a20015a4f5a5",
    "emailAccount": [
      {
        "key": "60f7b2b5b8f4a20015a4f5a6",
        "value": "[email protected]",
        "label": "Email account",
        "id": "60f7b2b5b8f4a20015a4f5a6",
        "name": "[email protected]"
      }
    ],
    "mergeTags": [
      {
        "tagName": "name",
        "type": "text"
      }
    ],
    "card": {
      "cardId": "60f7b2b5b8f4a20015a4f5a5",
      "title": "Welcome Card"
    }
  }
]
Retrieves detailed integration configuration information by integration ID. This endpoint returns comprehensive details about the configuration, including associated card information, available email accounts, and merge tag definitions.

Query Parameters

integrationId
string
required
The integration configuration ID returned when you created the configuration

Response Details

Returns an array with detailed configuration information:
key
string
Always “items” to identify the response type
cardId
string
ID of the card associated with this configuration
emailAccount
array
Available email accounts for this configuration
mergeTags
array
Merge tag fields available for this card
card
object
Information about the associated card

Response Example

[
  {
    "key": "items",
    "cardId": "60f7b2b5b8f4a20015a4f5a5",
    "emailAccount": [
      {
        "id": "60f7b2b5b8f4a20015a4f5a6",
        "fromEmail": "[email protected]"
      },
      {
        "id": "60f7b2b5b8f4a20015a4f5a7", 
        "fromEmail": "[email protected]"
      }
    ],
    "mergeTags": [
      {
        "tagName": "name",
        "type": "text"
      },
      {
        "tagName": "email",
        "type": "email"
      },
      {
        "tagName": "company",
        "type": "text"
      }
    ],
    "card": {
      "cardId": "60f7b2b5b8f4a20015a4f5a5",
      "title": "Welcome Card"
    }
  }
]

Authorizations

Authorization
string
header
required

Enter your CardClan integration key

Query Parameters

integrationId
string
required

Integration configuration ID

Response

Integration configuration retrieved successfully

key
string
Example:

"items"

cardId
string
Example:

"60f7b2b5b8f4a20015a4f5a5"

emailAccount
object[]
mergeTags
object[]
card
object