---
title: "Get sample card detail response"
method: GET
path: "/crm/extensions/cards-dev/2026-09/sample-response"
tags: ["Basic"]
---

# Get sample card detail response

`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

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.

## Response `200`

successful operation

- IntegratorCardPayloadResponse
  - `allItemsLinkUrl` string: 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` 'v1' | 'v3', required: The number version of the response.
  - `sections` IntegratorObjectResult[], required: A list of up to five valid card sub categories.
    - `actions` union[], required: A list of actions associated with the card, which can include action hooks, confirmation action hooks, or iframes.
      - union
        - ActionHookActionBody
          - `confirmation` ActionConfirmationBody
            - `cancelButtonLabel` string, required: The label for the button that cancels the action.
            - `confirmButtonLabel` string, required: The label for the button that confirms the action.
            - `prompt` string, required: The message displayed to the user to confirm the action.
          - `httpMethod` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required: The HTTP method to be used when making the call, which can be set to GET, POST, PUT, DELETE, or PATCH. If using GET or DELETE
          - `label` string: The label for this property as you'd like it displayed to users.
          - `propertyNamesIncluded` string[], required: A list of property names that will be included on the action. See the documentation for more information
          - `type` 'ACTION_HOOK', required: The type of status.
          - `url` string, required: The URL endpoint that will be called when the action is triggered.
        - IFrameActionBody
          - `height` integer, required: The height of the iframe in pixels.
          - `label` string: The label for this property as you'd like it displayed to users.
          - `propertyNamesIncluded` string[], required: A list of property names that will be included on the url of the iframe.
          - `type` 'IFRAME', required: The type of status.
          - `url` string, required: The URL endpoint that will be loaded in the iframe when triggered.
          - `width` integer, required: The width of the iframe in pixels.
    - `id` string, required: The unique identifier for the card.
    - `linkUrl` string: A URL used on the title of the card
    - `title` string, required: The top-level title for this card. Displayed to users in the CRM UI.
    - `tokens` ObjectToken[], required: A collection of tokens representing specific properties related to the card.
      - `dataType` 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING': Type of data represented by this property.
      - `label` string: The label for this property as you'd like it displayed to users.
      - `name` string: An internal identifier for this property. This value must be unique TODO.
      - `value` string, required: The value of the property
  - `topLevelActions` TopLevelActions
    - `primary` union: Defines the primary action for a card, which can be either an action hook or an iframe.
      - ActionHookActionBody
        - `confirmation` ActionConfirmationBody
          - `cancelButtonLabel` string, required: The label for the button that cancels the action.
          - `confirmButtonLabel` string, required: The label for the button that confirms the action.
          - `prompt` string, required: The message displayed to the user to confirm the action.
        - `httpMethod` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required: The HTTP method to be used when making the call, which can be set to GET, POST, PUT, DELETE, or PATCH. If using GET or DELETE
        - `label` string: The label for this property as you'd like it displayed to users.
        - `propertyNamesIncluded` string[], required: A list of property names that will be included on the action. See the documentation for more information
        - `type` 'ACTION_HOOK', required: The type of status.
        - `url` string, required: The URL endpoint that will be called when the action is triggered.
      - IFrameActionBody
        - `height` integer, required: The height of the iframe in pixels.
        - `label` string: The label for this property as you'd like it displayed to users.
        - `propertyNamesIncluded` string[], required: A list of property names that will be included on the url of the iframe.
        - `type` 'IFRAME', required: The type of status.
        - `url` string, required: The URL endpoint that will be loaded in the iframe when triggered.
        - `width` integer, required: The width of the iframe in pixels.
    - `secondary` union[], required: Specifies a list of secondary actions for a card, each of which can be an action hook or an iframe.
      - union
        - ActionHookActionBody
          - `confirmation` ActionConfirmationBody
            - `cancelButtonLabel` string, required: The label for the button that cancels the action.
            - `confirmButtonLabel` string, required: The label for the button that confirms the action.
            - `prompt` string, required: The message displayed to the user to confirm the action.
          - `httpMethod` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required: The HTTP method to be used when making the call, which can be set to GET, POST, PUT, DELETE, or PATCH. If using GET or DELETE
          - `label` string: The label for this property as you'd like it displayed to users.
          - `propertyNamesIncluded` string[], required: A list of property names that will be included on the action. See the documentation for more information
          - `type` 'ACTION_HOOK', required: The type of status.
          - `url` string, required: The URL endpoint that will be called when the action is triggered.
        - IFrameActionBody
          - `height` integer, required: The height of the iframe in pixels.
          - `label` string: The label for this property as you'd like it displayed to users.
          - `propertyNamesIncluded` string[], required: A list of property names that will be included on the url of the iframe.
          - `type` 'IFRAME', required: The type of status.
          - `url` string, required: The URL endpoint that will be loaded in the iframe when triggered.
          - `width` integer, required: The width of the iframe in pixels.
    - `settings` IFrameActionBody
      - `height` integer, required: The height of the iframe in pixels.
      - `label` string: The label for this property as you'd like it displayed to users.
      - `propertyNamesIncluded` string[], required: A list of property names that will be included on the url of the iframe.
      - `type` 'IFRAME', required: The type of status.
      - `url` string, required: The URL endpoint that will be loaded in the iframe when triggered.
      - `width` integer, required: The width of the iframe in pixels.
  - `totalCount` integer, required: The total number of card properties that will be sent in this response.

## Other responses

- `default`: An error occurred.

---

[API](https://skmtc.dev/hubspot/apis/crm-public-app-crm-cards.md) - [All operations](https://skmtc.dev/hubspot/apis/crm-public-app-crm-cards/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/crm-public-app-crm-cards/revisions/de6dd5bf92b9?raw)