> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.de/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve all CRM cards
> Gibt eine Liste mit Karten für eine bestimmte App zurück.
export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
const translations = {
header: "Unterstützte Produkte",
description: "Erfordert eines der folgenden Produkte oder höher.",
productNames: {
marketing: "Marketing Hub",
sales: "Sales Hub",
service: "Service Hub",
cms: "Content Hub"
},
tiers: {
free: "Kostenlos",
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"
}].filter(product => product.name && product.level);
if (products.length === 0) return null;
return
{translations.description}
{products.map((product, index) =>
{product.name} -{product.level}
)}
;
};
## OpenAPI
````yaml specs/legacy/v3/crm-public-app-crm-cards-v3.json GET /crm/v3/extensions/cards-dev/{appId}
openapi: 3.0.1
info:
title: CRM-Karten von öffentlicher App
description: >-
Allows an app to extend the CRM UI by surfacing custom cards in the sidebar
of record pages. These cards are defined up-front as part of app
configuration, then populated by external data fetch requests when the
record page is accessed by a user.
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
Fügen Sie den Kontaktdatensätzen eine benutzerdefinierte Karte hinzu, die
Daten aus Ihrer externen Bug-Tracking-Software anzeigt.
x-hubspot-related-documentation:
- name: Custom Cards Guide
url: https://developers.hubspot.com/docs/guides/api/crm/extensions/crm-cards
x-hubspot-introduction: >-
Erstellen Sie benutzerdefinierte Karten für Daten aus externen Systemen in
CRM-Datensätzen. Erfordert eine öffentliche App. Diese CRM-Karten
unterscheiden sich von den UI-Erweiterungen, die Sie mit Projekten erstellen
können.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
paths:
/crm/v3/extensions/cards-dev/{appId}:
get:
tags:
- Basic
summary: Alle Karten abrufen
description: Gibt eine Liste mit Karten für eine bestimmte App zurück.
operationId: get-/crm/v3/extensions/cards-dev/{appId}_getAll
parameters:
- name: appId
in: path
description: Die ID der App, die die alte(n) CRM-Karte(n) enthält
required: true
style: simple
explode: false
schema:
type: integer
format: int32
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublicCardListResponse'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- developers-read
- oauth2:
- private-apps-read
components:
schemas:
PublicCardListResponse:
required:
- results
type: object
properties:
results:
type: array
description: Eine Liste von Kartenantworten
items:
$ref: '#/components/schemas/PublicCardResponse'
PublicCardResponse:
required:
- actions
- auditHistory
- display
- fetch
- id
- title
type: object
properties:
actions:
$ref: '#/components/schemas/CardActions'
auditHistory:
type: array
description: >-
Eine Liste der auf der Karte durchgeführten Aktionen, einschließlich
Erstellung, Löschung und Aktualisierungen.
items:
$ref: '#/components/schemas/CardAuditResponse'
createdAt:
type: string
description: Der Zeitpunkt (Datum und Uhrzeit), zu dem die Karte erstellt wurde.
format: date-time
display:
$ref: '#/components/schemas/CardDisplayBody'
fetch:
$ref: '#/components/schemas/PublicCardFetchBody'
id:
type: string
description: Die eindeutige ID der Karte.
title:
type: string
description: >-
Der Top-Level-Titel für diese Karte. Wird den Benutzern in der
CRM-UI angezeigt.
updatedAt:
type: string
description: >-
Der Zeitpunkt (Datum und Uhrzeit), zu dem die Karte zuletzt
aktualisiert wurde.
format: date-time
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: Die Fehlerkategorie
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Kontext zur Fehlerbedingung
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
Eine eindeutige ID für die Anfrage. Berücksichtigen Sie diesen Wert
in Fehlerberichten oder Support-Tickets.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: Weitere Informationen zum Fehler
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
Eine Zuordnung der Namen von Links zu zugeordneten URIs mit einer
Dokumentation zum Fehler oder empfohlenen Abhilfemaßnahmen
message:
type: string
description: >-
Eine für Menschen lesbare Nachricht mit einer Beschreibung des
Fehlers und ggf. Abhilfemaßnahmen
example: An error occurred
subCategory:
type: string
description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält
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
CardActions:
required:
- baseUrls
type: object
properties:
baseUrls:
type: array
description: >-
Eine Liste von URL-Präfixen, die für Kartenaktions-URLs akzeptiert
werden. Wenn Ihre Datenabrufantwort eine Aktions-URL enthält, die
nicht mit einem dieser Werte beginnt, führt dies zu einem Fehler,
und die Karte wird nicht angezeigt.
items:
type: string
description: Configuration for custom user actions on cards.
example:
baseUrls:
- https://www.example.com/hubspot
CardAuditResponse:
required:
- actionType
- applicationId
- authSource
- changedAt
- initiatingUserId
- objectTypeId
type: object
properties:
actionType:
type: string
description: >-
Der Typ der ausgeführten Aktion mit möglichen Werten: CREATE,
DELETE, UPDATE.
enum:
- CREATE
- DELETE
- UPDATE
applicationId:
type: integer
description: Die ID der mit der Karte verbundenen Anwendung.
format: int32
authSource:
type: string
description: >-
Die Quelle der Authentifizierung für die Aktion, mit möglichen
Werten: APP, EXTERNAL, INTERNAL.
enum:
- APP
- EXTERNAL
- INTERNAL
changedAt:
type: integer
description: Der Zeitstempel, der angibt, wann die Änderung stattgefunden hat.
format: int64
initiatingUserId:
type: integer
description: Die ID des Benutzers, der die Aktion initiiert hat.
format: int32
objectTypeId:
type: integer
description: Die ID der Karte.
format: int64
CardDisplayBody:
required:
- properties
type: object
properties:
properties:
type: array
description: >-
Eigenschaften der Kartenanzeige. Diese werden als „label :
value“-Paare in der Karten-UI dargestellt. Weitere Details finden
Sie in der [Beispielkarte](#) in den Übersichtsdokumenten.
items:
$ref: '#/components/schemas/CardDisplayProperty'
description: Configuration for displayed info on a card
PublicCardFetchBody:
required:
- objectTypes
- targetUrl
type: object
properties:
objectTypes:
type: array
description: >-
Ein Array von CRM-Objekttypen, bei denen diese Karte angezeigt
werden soll. HubSpot ruft Ihre Ziel-URL auf, wenn ein Benutzer eine
Datensatzseite der hier definierten Typen aufruft.
items:
$ref: '#/components/schemas/CardObjectTypeBody'
targetUrl:
type: string
description: >-
URL zu einem Service-Endpunkt, der Details zu dieser Karte
zurückgibt. HubSpot ruft diesen Endpunkt jedes Mal auf, wenn ein
Benutzer eine CRM-Datensatzseite besucht, auf der diese Karte
angezeigt werden soll.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: Der Statuscode, der dem Fehlerdetail zugeordnet ist
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Kontext zur Fehlerbedingung
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
Der Name des Felds oder Parameters, in dem der Fehler gefunden
wurde.
message:
type: string
description: >-
Eine für Menschen lesbare Nachricht mit einer Beschreibung des
Fehlers und ggf. Abhilfemaßnahmen
subCategory:
type: string
description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält
CardDisplayProperty:
required:
- dataType
- label
- name
- options
type: object
properties:
dataType:
type: string
description: Typ der durch diese Eigenschaft dargestellten Daten.
enum:
- BOOLEAN
- CURRENCY
- DATE
- DATETIME
- EMAIL
- LINK
- NUMERIC
- STATUS
- STRING
label:
type: string
description: >-
Das Zuordnungslabel für diese Eigenschaft, wie sie den Benutzern
angezeigt werden soll
name:
type: string
description: >-
Eine interne ID für diese Eigenschaft. Dieser Wert muss ein
eindeutiges TO-DO sein.
options:
type: array
description: >-
Ein Array der verfügbaren Optionen, die angezeigt werden können.
Wird nur bei einem „dataType“ von „STATUS“ verwendet.
items:
$ref: '#/components/schemas/DisplayOption'
description: Definition for a card display property.
CardObjectTypeBody:
required:
- name
- propertiesToSend
type: object
properties:
name:
type: string
description: Ein CRM-Objekttyp, bei dem diese Karte angezeigt werden soll
enum:
- companies
- contacts
- deals
- marketing_events
- tickets
propertiesToSend:
type: array
description: >-
Ein Array von Eigenschaften, die an die Ziel-URL dieser Karte
gesendet werden sollen, wenn die Datenabrufanfrage gestellt wird. Es
muss sich um gültige Eigenschaften für den entsprechenden
CRM-Objekttyp handeln.
items:
type: string
DisplayOption:
required:
- label
- name
- type
type: object
properties:
label:
type: string
description: Der Text, der den Benutzern für diese Option angezeigt wird
name:
type: string
description: JSON-freundlicher eindeutiger Name für die Option
type:
type: string
description: Der Typ des Status
enum:
- DANGER
- DEFAULT
- INFO
- SUCCESS
- WARNING
description: Option definition for STATUS dataTypes.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
developers-read: ''
developers-write: ''
private-apps-read: ''
````
{product.name} -
{product.level}
)}