Skip to main content
POST
/
integration
/
cards
Get User Cards
curl --request POST \
  --url https://app.cardclan.io/api/integration/cards \
  --header 'Authorization: Bearer <token>'
[
  {
    "key": "card",
    "choices": [
      {
        "key": "60f7b2b5b8f4a20015a4f5a5",
        "label": "Card Id",
        "value": "60f7b2b5b8f4a20015a4f5a5",
        "id": "60f7b2b5b8f4a20015a4f5a5",
        "title": "Welcome Card",
        "name": "Welcome Card"
      }
    ]
  }
]
Retrieves all cards within a specific workspace. This endpoint requires a workspace ID parameter to scope the card search to a particular workspace.

​
Query Parameters

The workspace parameter is required and should contain the workspace ID obtained from the Get Workspaces endpoint.

​
Response Details

Returns an array containing card choices formatted for integration platforms:
  • key: Always “card” to identify the data type
  • choices: Array of available cards with their details
Each card in the choices array includes:
  • id: Unique card identifier (use this for sending cards)
  • title: Card name/title as set in CardClan
  • name: Same as title (for integration platform compatibility)
  • key: Same as ID
  • label: Description of the field type
  • value: Card identifier for form display

​
Use Cases

  • Card Selection: Present available cards to users in integration platforms
  • Workflow Setup: Allow users to choose which card to send in automations
  • Validation: Verify a specific card exists and is accessible
  • Dynamic Content: Build interfaces that adapt to available cards

​
Example Response Structure

[
  {
    "key": "card",
    "choices": [
      {
        "key": "60f7b2b5b8f4a20015a4f5a5",
        "label": "Card Id",
        "value": "60f7b2b5b8f4a20015a4f5a5",
        "id": "60f7b2b5b8f4a20015a4f5a5",
        "title": "Welcome Card",
        "name": "Welcome Card"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Enter your CardClan integration key

Query Parameters

​
workspace
string
required

Workspace ID

Response

Cards retrieved successfully

​
key
string
Example:

"card"

​
choices
object[]