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
{
  "totalCount": 123,
  "allItemsLinkUrl": "<string>",
  "cardLabel": "<string>",
  "responseVersion": "v1",
  "sections": [
    {
      "actions": [
        {
          "httpMethod": "CONNECT",
          "propertyNamesIncluded": [
            "<string>"
          ],
          "type": "ACTION_HOOK",
          "url": "<string>",
          "confirmation": {
            "cancelButtonLabel": "<string>",
            "confirmButtonLabel": "<string>",
            "prompt": "<string>"
          },
          "label": "<string>"
        }
      ],
      "id": "<string>",
      "title": "<string>",
      "tokens": [
        {
          "value": "<string>",
          "dataType": "BOOLEAN",
          "label": "<string>",
          "name": "<string>"
        }
      ],
      "linkUrl": "<string>"
    }
  ],
  "topLevelActions": {
    "secondary": [
      {
        "httpMethod": "CONNECT",
        "propertyNamesIncluded": [
          "<string>"
        ],
        "type": "ACTION_HOOK",
        "url": "<string>",
        "confirmation": {
          "cancelButtonLabel": "<string>",
          "confirmButtonLabel": "<string>",
          "prompt": "<string>"
        },
        "label": "<string>"
      }
    ],
    "primary": {
      "httpMethod": "CONNECT",
      "propertyNamesIncluded": [
        "<string>"
      ],
      "type": "ACTION_HOOK",
      "url": "<string>",
      "confirmation": {
        "cancelButtonLabel": "<string>",
        "confirmButtonLabel": "<string>",
        "prompt": "<string>"
      },
      "label": "<string>"
    },
    "settings": {
      "height": 123,
      "propertyNamesIncluded": [
        "<string>"
      ],
      "type": "IFRAME",
      "url": "<string>",
      "width": 123,
      "label": "<string>"
    }
  }
}

Supported products

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 card properties that will be sent in this response.

URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a See more [x] link if there are more than five items in your response, where [x] is the value of itemLabel.

cardLabel
string

The label to be used for the allItemsLinkUrl link (e.g. 'See more tickets'). If not provided, this falls back to the card's title.

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 March 30, 2026