Skip to main content
GET
/
integration
/
workspaces
Get User Workspaces
curl --request GET \
  --url https://app.cardclan.io/api/integration/workspaces \
  --header 'Authorization: Bearer <token>'
[
  {
    "key": "workspace",
    "choices": [
      {
        "key": "60f7b2b5b8f4a20015a4f5a4",
        "label": "Workspace Id",
        "value": "My Business Workspace",
        "id": "60f7b2b5b8f4a20015a4f5a4",
        "name": "My Business Workspace"
      }
    ]
  }
]
Retrieves all workspaces accessible to the authenticated user. Workspaces are containers that organize your cards and team collaboration in CardClan.

​
Response Details

The response returns an array containing workspace choices formatted for integration platforms:
  • key: Always “workspace” to identify the data type
  • choices: Array of available workspaces with their details
Each workspace in the choices array includes:
  • id: Unique workspace identifier (use this for other API calls)
  • name: Human-readable workspace name
  • key: Same as ID (for integration platform compatibility)
  • label: Description of the field type
  • value: Display name for the workspace

​
Use Cases

  • Dynamic Workspace Selection: Let users choose which workspace to send cards from
  • Multi-Tenant Applications: Support customers with multiple workspaces
  • Automation Setup: Discover available workspaces for workflow configuration
  • Access Validation: Verify which workspaces the integration key can access

​
Response Example

[
  {
    "key": "workspace",
    "choices": [
      {
        "key": "60f7b2b5b8f4a20015a4f5a4",
        "label": "Workspace Id",
        "value": "Marketing Team",
        "id": "60f7b2b5b8f4a20015a4f5a4",
        "name": "Marketing Team"
      },
      {
        "key": "60f7b2b5b8f4a20015a4f5a5",
        "label": "Workspace Id", 
        "value": "Sales Team",
        "id": "60f7b2b5b8f4a20015a4f5a5",
        "name": "Sales Team"
      }
    ]
  }
]

​
Next Steps

After getting workspaces, you typically want to:
  1. Get Cards: Use the workspace ID to retrieve available cards
  2. Set Up Integration Config: Create configurations linking cards to workflows
  3. Send Cards: Execute card delivery using the workspace’s cards

Authorizations

​
Authorization
string
header
required

Enter your CardClan integration key

Response

Workspaces retrieved successfully

​
key
string
Example:

"workspace"

​
choices
object[]