> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

---
id: 99b43d09-9eb2-49f3-bf5f-910609114399
---

# 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.

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel}) => {
  const translations = {
    description: "Requires one of the following products or higher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub",
      data: "Data Hub",
      commerce: "Revenue Hub"
    },
    tiers: {
      free: "Free",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<Accordion title="Supported products" defaultOpen="true" icon="cubes">
  <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
</Accordion>


## OpenAPI

````yaml specs/2026-03/crm-public-app-crm-cards-v2026-03.json GET /crm/extensions/cards-dev/2026-03/sample-response
openapi: 3.0.1
info:
  title: Public App Crm Cards
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    Add a custom card to contact records that displays data from your external
    bug tracking software.
  x-hubspot-introduction: >-
    Create custom cards to data from external systems on CRM records. Requires a
    public public app. These CRM cards are different from the UI extensions you
    can create with projects.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
paths:
  /crm/extensions/cards-dev/2026-03/sample-response:
    get:
      tags:
        - Basic
      summary: Get sample card detail response
      description: >-
        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.
      operationId: >-
        get-/crm/extensions/cards-dev/2026-03/sample-response_getCardsSampleResponse
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegratorCardPayloadResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
components:
  schemas:
    IntegratorCardPayloadResponse:
      required:
        - responseVersion
        - sections
        - totalCount
      type: object
      properties:
        allItemsLinkUrl:
          type: string
          description: >-
            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:
          type: string
          description: >-
            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:
          type: string
          description: The number version of the response.
          enum:
            - v1
            - v3
        sections:
          type: array
          description: A list of up to five valid card sub categories.
          items:
            $ref: '#/components/schemas/IntegratorObjectResult'
        topLevelActions:
          $ref: '#/components/schemas/TopLevelActions'
        totalCount:
          type: integer
          description: >-
            The total number of card properties that will be sent in this
            response.
          format: int32
    IntegratorObjectResult:
      required:
        - actions
        - id
        - title
        - tokens
      type: object
      properties:
        actions:
          type: array
          description: >-
            A list of actions associated with the card, which can include action
            hooks, confirmation action hooks, or iframes.
          items:
            oneOf:
              - $ref: '#/components/schemas/ActionHookActionBody'
              - $ref: '#/components/schemas/IFrameActionBody'
        id:
          type: string
          description: The unique identifier for the card.
        linkUrl:
          type: string
          description: A URL used on the title of the card
        title:
          type: string
          description: The top-level title for this card. Displayed to users in the CRM UI.
        tokens:
          type: array
          description: >-
            A collection of tokens representing specific properties related to
            the card.
          items:
            $ref: '#/components/schemas/ObjectToken'
    TopLevelActions:
      required:
        - secondary
      type: object
      properties:
        primary:
          description: >-
            Defines the primary action for a card, which can be either an action
            hook or an iframe.
          oneOf:
            - $ref: '#/components/schemas/ActionHookActionBody'
            - $ref: '#/components/schemas/IFrameActionBody'
        secondary:
          type: array
          description: >-
            Specifies a list of secondary actions for a card, each of which can
            be an action hook or an iframe.
          items:
            oneOf:
              - $ref: '#/components/schemas/ActionHookActionBody'
              - $ref: '#/components/schemas/IFrameActionBody'
        settings:
          $ref: '#/components/schemas/IFrameActionBody'
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            A unique identifier for the request. Include this value with any
            error reports or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map of link names to associated URIs containing documentation
            about the error or recommended remediation steps
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ActionHookActionBody:
      title: ACTION_HOOK
      required:
        - httpMethod
        - propertyNamesIncluded
        - type
        - url
      type: object
      properties:
        confirmation:
          $ref: '#/components/schemas/ActionConfirmationBody'
        httpMethod:
          type: string
          description: >-
            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
          enum:
            - CONNECT
            - DELETE
            - GET
            - HEAD
            - OPTIONS
            - PATCH
            - POST
            - PUT
            - TRACE
        label:
          type: string
          description: The label for this property as you'd like it displayed to users.
        propertyNamesIncluded:
          type: array
          description: >-
            A list of property names that will be included on the action. See
            the documentation for more information
          items:
            type: string
        type:
          type: string
          description: The type of status.
          default: ACTION_HOOK
          enum:
            - ACTION_HOOK
        url:
          type: string
          description: The URL endpoint that will be called when the action is triggered.
      x-hubspot-sub-type-impl: true
    IFrameActionBody:
      title: IFRAME
      required:
        - height
        - propertyNamesIncluded
        - type
        - url
        - width
      type: object
      properties:
        height:
          type: integer
          description: The height of the iframe in pixels.
          format: int32
        label:
          type: string
          description: The label for this property as you'd like it displayed to users.
        propertyNamesIncluded:
          type: array
          description: >-
            A list of property names that will be included on the url of the
            iframe.
          items:
            type: string
        type:
          type: string
          description: The type of status.
          default: IFRAME
          enum:
            - IFRAME
        url:
          type: string
          description: The URL endpoint that will be loaded in the iframe when triggered.
        width:
          type: integer
          description: The width of the iframe in pixels.
          format: int32
      x-hubspot-sub-type-impl: true
    ObjectToken:
      required:
        - value
      type: object
      properties:
        dataType:
          type: string
          description: Type of data represented by this property.
          enum:
            - BOOLEAN
            - CURRENCY
            - DATE
            - DATETIME
            - EMAIL
            - LINK
            - NUMERIC
            - STATUS
            - STRING
        label:
          type: string
          description: The label for this property as you'd like it displayed to users.
        name:
          type: string
          description: >-
            An internal identifier for this property. This value must be unique
            TODO.
        value:
          type: string
          description: The value of the property
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
    ActionConfirmationBody:
      required:
        - cancelButtonLabel
        - confirmButtonLabel
        - prompt
      type: object
      properties:
        cancelButtonLabel:
          type: string
          description: The label for the button that cancels the action.
        confirmButtonLabel:
          type: string
          description: The label for the button that confirms the action.
        prompt:
          type: string
          description: The message displayed to the user to confirm the action.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'

````