Skip to main content
GET
/
crm
/
v3
/
extensions
/
cards-dev
/
sample-response
Get sample card detail response
curl --request GET \
  --url https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response
{
  "allItemsLinkUrl": "https://example.com/all-items-link-url",
  "cardLabel": "Tickets",
  "responseVersion": "v3",
  "sections": [
    {
      "actions": [
        {
          "httpMethod": "POST",
          "label": "action-hook-label",
          "propertyNamesIncluded": [
            "email",
            "firstName"
          ],
          "type": "ACTION_HOOK",
          "url": "https://example.com/action-hook-frame"
        },
        {
          "confirmation": {
            "cancelButtonLabel": "Cancel",
            "confirmButtonLabel": "Continue",
            "prompt": "action-confirmation-body-prompt"
          },
          "httpMethod": "POST",
          "label": "confirmation-hook-label",
          "type": "ACTION_HOOK",
          "url": "https://example.com/confirmation-action-hook"
        },
        {
          "height": 480,
          "label": "iframe-action-label",
          "propertyNamesIncluded": [
            "property1",
            "property2",
            "property3"
          ],
          "type": "IFRAME",
          "url": "https://example.com/iframe-action-label",
          "width": 640
        }
      ],
      "id": "123",
      "linkUrl": "http://example.com/1",
      "title": "API-22: APIs working too fast",
      "tokens": [
        {
          "dataType": "DATE",
          "label": "test_label",
          "name": "created",
          "value": "2016-08-04"
        }
      ]
    }
  ],
  "topLevelActions": {
    "primary": {
      "height": 480,
      "label": "test_label_primary",
      "type": "IFRAME",
      "url": "https://example.com/primary-iframe",
      "width": 640
    },
    "secondary": [
      {
        "height": 480,
        "label": "test_label_secondary",
        "type": "IFRAME",
        "url": "https://example.com/secondary-iframe",
        "width": 640
      }
    ],
    "settings": {
      "height": 480,
      "label": "Edit",
      "propertyNamesIncluded": [
        "some_crm_property"
      ],
      "type": "IFRAME",
      "url": "https://example.com/iframe-contents",
      "width": 640
    }
  },
  "totalCount": 1
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
Data HubData Hub -Free

Response

successful operation

The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.

totalCount
integer<int32>
required

The total number of cards that are sent in this response.

URL to a page the integrator has built that displays all details for the object cards. This URL will be displayed to users on the title of the card.

cardLabel
string

The label to be used for the allItemsLinkUrl link (e.g. 'See more tickets') and the title of the card.

responseVersion
enum<string>

The number version of the response.

Available options:
v1,
v3
sections
object[]

A list of up to five valid card sub categories.

topLevelActions
object
Last modified on December 16, 2025