Get the details for a property
Rufen Sie eine bestimmte Eigenschaft für einen bestimmten Objekttyp innerhalb einer bestimmten App ab. Dieser Endpunkt ermöglicht Ihnen den Zugriff auf Details zu einer Eigenschaft, einschließlich ihrer Konfiguration und Einstellungen, für einen bestimmten Objekttyp, der durch den Eigenschaftsnamen identifiziert wird. Dies kann für Integrationszwecke oder zum Verständnis von Eigenschaftskonfigurationen nützlich sein.
Supported products
Supported products
Autorisierungen
The access token received from the authorization server in the OAuth 2.0 flow.
Pfadparameter
Die eindeutige ID der App, die der Eigenschaft zugeordnet ist.
Der Objekttyp, für den die Eigenschaft abgerufen wird.
Der Name der abzurufenden Eigenschaft.
Abfrageparameter
Ob nur Ergebnisse zurückgegeben werden sollen, die archiviert wurden. Der Standardwert ist „false“.
Eine kommagetrennte Liste von Eigenschaftsnamen, die in die Antwort aufgenommen werden sollen.
Antwort
successful operation
A HubSpot property
Ein Array von Zeichenfolgen, die die Objekttypen darstellen, die für diese Eigenschaft zulässig sind.
Ein boolescher Wert, der angibt, ob die Eigenschaft berechnet wird.
Ein boolescher Wert, der angibt, ob die Eigenschaft archiviert werden kann.
Ein boolescher Wert, der angibt, ob die Eigenschaft wiederhergestellt werden kann.
Eine Zeichenfolge, die Datum und Uhrzeit der Erstellung der Eigenschaft im ISO 8601-Format darstellt.
Eine Zeichenfolge, die die Benutzer-ID des Erstellers der Eigenschaft darstellt.
Eine Zeichenfolge, die den Namen der Währungseigenschaft darstellt, die dieser Eigenschaft zugeordnet ist.
Eine Zeichenfolge, die die Vertraulichkeitsstufe der Daten angibt.
high, none, standard Eine Zeichenfolge, die einen Hinweis zur Anzeige von Datumsangaben gibt.
absolute, absolute_with_relative, time_since, time_until Ein boolescher Wert, der angibt, ob die Eigenschaft gelöscht wurde.
Eine Zeichenfolge mit einer Beschreibung der Eigenschaft.
Eine Zeichenfolge, die den Anzeigemodus der Eigenschaft angibt.
all_unique_versions, current_value Eine Ganzzahl, die die Reihenfolge angibt, in der die Eigenschaft angezeigt wird.
Ein boolescher Wert, der angibt, ob die Eindeutigkeit für mehrwertige Eigenschaften erzwungen wird.
Ein boolescher Wert, der angibt, ob die Eigenschaft externe Optionen hat.
Eine Zeichenfolge, die den Referenz-Typ für externe Optionen angibt.
Ein boolescher Wert, der angibt, ob die Eigenschaft als Favorit markiert ist.
Eine Ganzzahl, die die Reihenfolge einer Eigenschaft in den Favoriten angibt.
Eine Zeichenfolge, die den Feldtyp der Eigenschaft angibt, z. B. „booleancheckbox“, „calculation_equation“, „checkbox“, „date“, „file“, „html“, „number“, „phonenumber“, „radio“, „select“, „text“ oder „textarea“.
Ein boolescher Wert, der angibt, ob die Eigenschaft als Formularfeld verwendet wird.
Eine Zeichenfolge, die die Benutzer-ID darstellt, von der die Eigenschaft stammt.
Eine Zeichenfolge, die den Namen der Gruppe darstellt, zu der die Eigenschaft gehört.
Ein boolescher Wert, der angibt, ob die Eigenschaft einen eindeutigen Wert hat.
Ein boolescher Wert, der angibt, ob die Eigenschaft ausgeblendet ist.
false
Ein boolescher Wert, der angibt, ob die Eigenschaft von HubSpot definiert ist.
Ein boolescher Wert, der angibt, ob die Eigenschaft eine angepasste Standardeinstellung ist.
Ein boolescher Wert, der angibt, ob die Eigenschaft mehrere Werte haben kann.
Ein boolescher Wert, der angibt, ob die Eigenschaft partiell ist.
Eine Zeichenfolge, die das Label der Eigenschaft darstellt und zu Anzeigezwecken verwendet wird.
Ein boolescher Wert, der angibt, ob die Eigenschaftsdefinition änderbar, aber nicht löschbar ist.
Eine Zeichenfolge, die den Namen der Eigenschaft darstellt.
Eine Zeichenfolge, die einen Hinweis zur Anzeige von Zahlen enthält. Zu den Optionen gehören „unformatted“, „formatted“, „currency“, „percentage“, „duration“ und „probability“.
currency, duration, formatted, percentage, probability, unformatted Eine Zeichenfolge, die die Strategie zum Sortieren von Optionen angibt.
ALPHABETICAL, DISPLAY_ORDER Ein Array von Optionen, die für die Eigenschaft verfügbar sind. Anwendbar, wenn der Eigenschaftstyp Optionen unterstützt.
Ein boolescher Wert, der angibt, ob die Optionen für die Eigenschaft veränderbar sind.
Eine Ganzzahl, die die ID der App darstellt, die für die Eigenschaft zuständig ist.
Eine Ganzzahl, die die eindeutige ID für das Portal darstellt.
Ein boolescher Wert, der angibt, ob die Definition der Eigenschaft schreibgeschützt ist.
Ein boolescher Wert, der angibt, ob der Wert der Eigenschaft schreibgeschützt ist.
Eine Zeichenfolge, die den Typ des Objekts angibt, auf das die Eigenschaft verweist.
ABANDONED_CART, ACCEPTANCE_TEST, AD, AD_ACCOUNT, AD_CAMPAIGN, AD_GROUP, AI_FORECAST, ALL_PAGES, APPROVAL, APPROVAL_STEP, ATTRIBUTION, AUDIENCE, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM_FLOW, AUTOMATION_PLATFORM_FLOW_ACTION, BET_ALERT, BET_DELIVERABLE_SERVICE, BLOG_LISTING_PAGE, BLOG_POST, CALL, CAMPAIGN, CAMPAIGN_BUDGET_ITEM, CAMPAIGN_SPEND_ITEM, CAMPAIGN_STEP, CAMPAIGN_TEMPLATE, CAMPAIGN_TEMPLATE_STEP, CART, CASE_STUDY, CHATFLOW, CLIP, CMS_URL, COMBO_EVENT_CONFIGURATION, COMMERCE_PAYMENT, COMMUNICATION, COMPANY, CONTACT, CONTACT_CREATE_ATTRIBUTION, CONTENT, CONTENT_AUDIT, CONTENT_AUDIT_PAGE, CONVERSATION, CONVERSATION_INBOX, CONVERSATION_SESSION, CRM_OBJECTS_DUMMY_TYPE, CRM_PIPELINES_DUMMY_TYPE, CTA, CTA_VARIANT, DATA_PRIVACY_CONSENT, DATA_SYNC_STATE, DEAL, DEAL_CREATE_ATTRIBUTION, DEAL_REGISTRATION, DEAL_SPLIT, DISCOUNT, DISCOUNT_CODE, DISCOUNT_TEMPLATE, EMAIL, ENGAGEMENT, EXPORT, EXTERNAL_WEB_URL, FEE, FEEDBACK_SUBMISSION, FEEDBACK_SURVEY, FILE_MANAGER_FILE, FILE_MANAGER_FOLDER, FOLDER, FORECAST, FORM, FORM_SUBMISSION_INBOUNDDB, GOAL_TARGET, GOAL_TARGET_GROUP, GOAL_TEMPLATE, GSC_PROPERTY, HUB, IMPORT, INVOICE, KEYWORD, KNOWLEDGE_ARTICLE, LANDING_PAGE, LEAD, LINE_ITEM, MARKETING_CALENDAR, MARKETING_CAMPAIGN_UTM, MARKETING_EMAIL, MARKETING_EVENT, MARKETING_EVENT_ATTENDANCE, MARKETING_SMS, MEDIA_BRIDGE, MEETING_EVENT, MIC, NOTE, OBJECT_LIST, ORDER, OWNER, PARTNER_ACCOUNT, PARTNER_CLIENT, PARTNER_CLIENT_REVENUE, PARTNER_SERVICE, PAYMENT_LINK, PAYMENT_SCHEDULE, PAYMENT_SCHEDULE_INSTALLMENT, PERMISSIONS_TESTING, PLAYBOOK, PLAYBOOK_QUESTION, PLAYBOOK_SUBMISSION, PLAYBOOK_SUBMISSION_ANSWER, PLAYLIST, PLAYLIST_FOLDER, PODCAST_EPISODE, PORTAL, PORTAL_OBJECT_SYNC_MESSAGE, POSTAL_MAIL, PRIVACY_SCANNER_COOKIE, PRODUCT, PRODUCT_OR_FOLDER, PROPERTY_INFO, PROSPECTING_AGENT_CONTACT_ASSIGNMENT, PUBLISHING_TASK, QUARANTINED_SUBMISSION, QUOTA, QUOTE, QUOTE_FIELD, QUOTE_MODULE, QUOTE_MODULE_FIELD, QUOTE_TEMPLATE, RESTORABLE_CRM_OBJECT, ROSTER, ROSTER_MEMBER, SALES_DOCUMENT, SALES_TASK, SALES_WORKLOAD, SALESFORCE_SYNC_ERROR, SCHEDULING_PAGE, SCHEMAS_BACKEND_TEST, SCORE_CONFIGURATION, SEQUENCE, SEQUENCE_ENROLLMENT, SEQUENCE_STEP, SEQUENCE_STEP_ENROLLMENT, SERVICE, SITE_PAGE, SNIPPET, SOCIAL_BROADCAST, SOCIAL_CHANNEL, SOCIAL_POST, SOCIAL_PROFILE, SOX_PROTECTED_DUMMY_TYPE, SOX_PROTECTED_TEST_TYPE, SUBMISSION_TAG, SUBSCRIPTION, TASK, TASK_TEMPLATE, TAX, TEMPLATE, TICKET, UNKNOWN, UNSUBSCRIBE, USER, VIEW, VIEW_BLOCK, WEB_INTERACTIVE Eine Zeichenfolge, die den Modus der Textanalyse für Suchzwecke angibt.
NONE, NOT_ANALYZED_TEXT Ein boolescher Wert, der angibt, ob die Eigenschaft in der globalen Suche durchsuchbar ist.
Ein Array von Zeichenfolgen, die die Kategorien vertraulicher Daten darstellen, die dieser Eigenschaft zugeordnet sind.
Ein boolescher Wert, der angibt, ob das Währungssymbol für die Eigenschaft angezeigt werden soll.
Eine Zeichenfolge, die einen Hinweis zur Textanzeige gibt. Zu den Optionen gehören „unformatted_single_line“, „multi_line“, „email“, „phone_number“, „domain_name“, „ip_address“, „physical_address“ und „postal_code“.
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line Eine Zeichenfolge, die den Typ der Eigenschaft angibt, z. B. „bool“, „date“, „datetime“, „enumeration“, „number“, „phone_number“ oder „string“.
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string Eine Zeichenfolge, die Datum und Uhrzeit der letzten Aktualisierung der Eigenschaft im ISO 8601-Format darstellt.