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>"
}
}
}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.
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
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.
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.
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.
The number version of the response.
v1, v3 A list of up to five valid card sub categories.
Show child attributes
Show child attributes
Was this page helpful?