Basic

Get sample card detail response

Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.

get/crm/extensions/cards-dev/2026-09/sample-response

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/extensions/cards-dev/2026-09/sample-response
  • Auth
    none declared

Response

successful operation

allItemsLinkUrlstring

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.

cardLabelstring

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'v1' | 'v3' required

The number version of the response.

totalCountinteger required

The total number of card properties that will be sent in this response.

Changes

No recorded changes to this operation across all 5 revisions of this API.